License

Copyright 2022 Apache Foundation

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Preface

© 2015-2022

Apache Fineract
Website: fineract.apache.org
Email: dev@fineract.apache.org

Version: 1.6.1-107c2290

Date: 2022-05-09

Table 1. Authors
Name Email

Michael Vorburger

mike@vorburger.ch

Aleksandar Vidakovic

aleks@apache.org

Arnold Galovics

arnold@apache.org

Table 2. History
Authors Description Date Version

Aleksandar Vidakovic

Initial version

2020-10-26

1.4.0

Arnold Galovics

Database architecture section

2022-03-11

1.7.0

Aleksandar Vidakovic

Module section

2022-03-23

1.7.0

Aleksandar Vidakovic

Release section, file re-organisation

2022-04-18

1.7.0

Aleksandar Vidakovic

AsciiDoc cheatsheet

2022-05-09

1.7.0

Table of Contents

Introduction

Platform for Digital Financial Services

Apache Fineract (\โ€™fฤซn-,ำ™-,rakt\) is open source software for financial services.

Fineract provides a reliable, robust, and affordable solution for entrepreneurs, financial institutions, and service providers to offer financial services to the worldโ€™s 2 billion underbanked and unbanked. Fineract is aimed at innovative mobile and cloud-based solutions, and enables digital transaction accounts for all.

Fineract 1.x is a mature platform with open APIs, while Fineract CN is a cloud native, microservice architecture also supporting open banking APIs.

About

Apache Fineract can be deployed in any environment: cloud or on-premise. It can support front end interfaces on or offline, mobile or PC. Itโ€™s extensible enough to support any organizational type or delivery channel, and flexible enough to support any product, service, or lending methodology. For any organization, big or small, it provides the client data management, loan and savings portfolio management, integrated real time accounting, and social and financial reporting needed to bring digital financial services to a modern connected world.

Fineract 1.x compares well to other core banking systems and draws from requirements in credit unions, microfinance institutions, and small non-banking financial institutions. Features include flexible product configuration, KYC documentation support, business rule sets, payment transactions, and portfolio management. It includes an open API that dates to 2011 and is deployed in relatively high transaction volume environments.

Fineract CN operates on the principle that financial services are an innovative space and so each fineract microservice encapsulates a domain that can be combined with other microservices to create new platform offerings. Fineract CN microservices can be combined to create new software platforms for digital financial service providers. Fineract CN is still in its early days, but preliminary tests have shown that a simple single-instance laptop deployment of Fineract CN can process over 1000 transactions/second. Fineract CN also includes a fully Apache-licensed backoffice UI.

Fineract 1.x began incubation at Apache in December 2015 and is used by an active community of companies who build solutions for both financial inclusion and fintech innovation.

Contribute

The Apache Fineract community welcomes contributors who want to support the Fineract technology. Our community builds everything from this website, to the Fineract code to documentation and best practices information.

We especially welcome additions and corrections to the documentation, wiki, and website to improve the user experience. Bug reports and fixes and additions to the Apache Fineract code are welcome. Helping users learn best practices also earns good karma in our community.

Mailing Lists

Users & Developers

If you use, build on top of, deploy or are building contributions and modifications to Apache Fineract, this is the list for you.
To subscribe, send a blank email to dev-subscribe@fineract.apache.org.
To unsubscribe later, just send a blank email to dev-unsubscribe@fineract.apache.org.
You can also read the archives on lists.apache.org or on MarkMail.org.
Commits

This list receives an email whenever new code is contributed to Apache Fineract.
To subscribe, send a blank email to commits-subscribe@fineract.apache.org.
You can also read the archives.

Deployment

Plugins

Apache Fineract is extensible through plugin JARs (FINERACT-1177; based on
Spring Boot’s support). To launch Fineract with plugin JARs in libs/*.jar, use:

java -Dloader.path=libs/ -jar fineract-provider.jar

The Fineract "Docker" container image’s ENTRYPOINT uses this, see our Dockerfile. You could therefore build your customized Fineract distribution container image with your own Dockerfile using e.g. FROM apache/fineract:latest and then drop some plugin JARs into /app/libs/.

The WAR distribution does not directly support such plugins, but one could "explode" the WAR and drop JARs into WEB-INF/lib; if you know what you are doing, and feel nostalgic of the 1990s still using WARs, instead of the recommended modern Spring Boot distribution.

Here is a list of known 3rd-party plugin projects which can be dropped into libs/:

The reporting module became our first module experiment out of necessity. We are currently developing a strategy to split up even more internals of Fineract into proper modules. Those that have an incompatible license will be hosted in a separate Git repository (probably on Github under the Mifos organisation). We’ll send out an announcement as soon as we have more to say on this topic.

HTTPS

Because Apache Fineract deals with customer sensitive personally identifiable information (PII), it very strongly encourages all developers, implementors and end-users to always only use HTTPS. This is why it does not run on HTTP even for local development and enforces use of HTTPS.

For this purpose, Fineract includes a built-in default SSL certificate. This cert is intended for development on localhost, only. It is not trusted by your browser (because it’s self signed).

For production deployments, we recommend running Fineract behind a modern managed cloud native web proxy which includes SSL termination with automatically rotating SSL certificates, either using your favourite cloud provider’s respective solution, or locally setting up the equivalent using e.g. something like NGINX combined with Letโ€™s Encrypt.

Such products, when correctly configured, add the conventional X-Forwarded-For and X-Forwarded-Proto HTTP headers, which Fineract (or rather the Spring Framework really) correctly respects since FINERACT-914 was fixed.

Alternatively, you could replace the built-in default SSL certificate with one you obtained from a Certificate Authority. We currently do not document how to do this, because we do not recommend this approach, as its cumbersome to configure and support and less secure than a managed auto rotating solution.

The Fineract API client supports an insecure mode (FineractClient.Builder#insecure()), and API users such as mobile apps may expose Settings to let end-users accept the self signed certificate. This should always be used for testing only, never in production.

Docker Compose

TBD

Application Server

Tomcat

TBD

Undertow

TBD

Jetty

TBD

JBoss

TBD

Weblogic

TBD

Payara

TBD

Kubernetes

TBD

AWS

TBD

Google Cloud

The www.fineract.dev demo server runs on Google Cloud.

The Running Fineract.dev, SRE style presentation given at ApacheCon 2020 has some related background.

Apache Software Foundation Infrastructure

We can order a server from Apache’s infrastructure team and deploy a demo instance…​

TBD

Architecture

This document captures the major architectural decisions in platform. The purpose of the document is to provide a guide to the overall structure of the platform; where it fits in the overall context of an MIS solution and its internals so that contributors can more effectively understand how changes that they are considering can be made, and the consequences of those changes.

The target audience for this report is both system integrators (who will use the document to gain an understanding of the structure of the platform and its design rationale) and platform contributors who will use the document to reason about future changes and who will update the document as the system evolves.

History

The Idea

Fineract was an idea born out of a wish to create and deploy technology that allows the microfinance industry to scale. The goal is to:

  • Produce a gold standard management information system suitable for microfinance operations

  • Acts as the basis of a platform for microfinance

  • Open source, owned and driven by member organisations in the community

  • Enabling potential for eco-system of providers located near to MFIs

Timeline

  • 2006: Project intiated by Grameen Foundation

  • Late 2011: Grameen Foundation handed over full responsibility to open source community.

  • 2012: Mifos X platform started. Previous members of project come together under the name of Community for Open Source Microfinance (COSM / OpenMF)

  • 2013: COSM / OpenMF officially rebranded to Mifos Initiative and receive US 501c3 status.

  • 2016: Fineract 1.x began incubation at Apache

System Overview

platform systemview
Figure 1. Platform System Overview

Financial institutions deliver their services to customers through a variety of means today.

  • Customers can call direct into branches (teller model)

  • Customers can organise into groups (or centers) and agree to meetup at a location and time with FI staff (traditional microfinance).

  • An FI might have a public facing information portal that customers can use for variety of reasons including account management (online banking).

  • An FI might be integrated into a ATM/POS/Card services network that the customer can use.

  • An FI might be integrated with a mobile money operator and support mobile money services for customer (present/future microfinance).

  • An FI might use third party agents to sell on products/services from other banks/FIs.

As illustrated in the above diagram, the various stakeholders leverage business apps to perform specific customer or FI related actions. The functionality contained in these business apps can be bundled up and packaged in any way. In the diagram, several of the apps may be combined into one app or any one of the blocks representing an app could be further broken up as needed.

The platform is the core engine of the MIS. It hides alot of the complexity that exists in the business and technical domains needed for an MIS in FIs behind a relatively simple API. It is this API that frees up app developers to innovate and produce apps that can be as general or as bespoke as FIs need them to be.

Functional Overview

As ALL capabilities of the platform are exposed through an API, The API docs are the best place to view a detailed breakdown of what the platform does. See online API Documentation.

platform categories
Figure 2. Platform Functional Overview

At a higher level though we see the capabilities fall into the following categories:

  • Infrastructure

    • Codes

    • Extensible Data Tables

    • Reporting

  • User Administration

    • Users

    • Roles

    • Permissions

  • Organisation Modelling

    • Offices

    • Staff

    • Currency

  • Product Configuration

    • Charges

    • Loan Products

    • Deposit Products

  • Client Data

    • Know Your Client (KYC)

  • Portfolio Management

    • Loan Accounts

    • Deposit Accounts

    • Client/Groups

  • GL Account Management

    • Chart of Accounts

    • General Ledger

Principles

RESTful API

The platform exposes all its functionality via a practically-RESTful API, that communicates using JSON.

We use the term practically-RESTful in order to make it clear we are not trying to be fully REST compliant but still maintain important RESTful attributes like:

  • Stateless: platform maintains no conversational or session-based state. The result of this is ability to scale horizontally with ease.

  • Resource-oriented: API is focussed around set of resources using HTTP vocabulary and conventions e.g GET, PUT, POST, DELETE, HTTP status codes. This results in a simple and consistent API for clients.

See online API Documentation for more detail.

Multi-tenanted

The Fineract platform has been developed with support for multi-tenancy at the core of its design. This means that it is just as easy to use the platform for Software-as-a-Service (SaaS) type offerings as it is for local installations.

The platform uses an approach that isolates an FIs data per database/schema (See Separate Databases and Shared Database, Separate Schemas).

Extensible

Whilst each tenant will have a set of core tables, the platform tables can be extended in different ways for each tenant through the use of Data tables functionality.

Command Query Seperation

We seperate commands (that change data) from queries (that read data).

Why? There are numerous reasons for choosing this approach which at present is not an attempt at full blown CQRS. The main advantages at present are:

  • State changing commands are persisted providing an audit of all state changes.

  • Used to support a general approach to maker-checker.

  • State changing commands use the Object-Oriented paradign (and hence ORM) whilst querys can stay in the data paradigm.

Maker-Checker

Also known as four-eyes principal. Enables apps to support a maker-checker style workflow process. Commands that pass validation will be persisted. Maker-checker can be enabled/disabled at fine-grained level for any state changing API.
Fine grained access control

A fine grained permission is associated with each API. Administrators have fine grained control over what roles or users have access to.

Package Structure

The intention is for platform code to be packaged in a vertical slice way (as opposed to layers).
Source code starts from github.com/apache/fineract/tree/develop/fineract-provider/src/main/java/org/apache/fineract

  • accounting

  • useradministration

  • infrastructure

  • portfolio

    • charge

    • client

    • fund

    • loanaccount

  • accounting

Within each vertical slice is some common packaging structure:

  • api - XXXApiResource.java - REST api implementation files

  • handler - XXXCommandHandler.java - specific handlers invoked

  • service - contains read + write services for functional area

  • domain - OO concepts for the functional area

  • data - Data concepts for the area

  • serialization - ability to convert from/to API JSON for functional area

Design Overview

The implementation of the platform code to process commands through handlers whilst supporting maker-checker and authorisation checks is a little bit convoluted at present and is an area pin-pointed for clean up to make it easier to on board new platform developers. In the mean time below content is used to explain its workings at present.
command query
Figure 3. CQRS

Taking into account example shown above for the users resource.

  • Query: GET /users

  • HTTPS API: retrieveAll method on org.apache.fineract.useradministration.api.UsersApiResource invoked

  • UsersApiResource.retrieveAll: Check user has permission to access this resources data.

  • UsersApiResource.retrieveAll: Use 'read service' to fetch all users data ('read services' execute simple SQL queries against Database using JDBC)

  • UsersApiResource.retrieveAll: Data returned to coverted into JSON response

  • Command: POST /users (Note: data passed in request body)

  • HTTPS API: create method on org.apache.fineract.useradministration.api.UsersApiResource invoked

UsersApiResource.create
    @POST
    @Operation(summary = "Create a User", description = "Adds new application user.\n" + "\n"
            + "Note: Password information is not required (or processed). Password details at present are auto-generated and then sent to the email account given (which is why it can take a few seconds to complete).\n"
            + "\n" + "Mandatory Fields: \n" + "username, firstname, lastname, email, officeId, roles, sendPasswordToEmail\n" + "\n"
            + "Optional Fields: \n" + "staffId,passwordNeverExpires,isSelfServiceUser,clients")
    @RequestBody(required = true, content = @Content(schema = @Schema(implementation = UsersApiResourceSwagger.PostUsersRequest.class)))
    @ApiResponses({
            @ApiResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(implementation = UsersApiResourceSwagger.PostUsersResponse.class))) })
    @Consumes({ MediaType.APPLICATION_JSON })
    @Produces({ MediaType.APPLICATION_JSON })
    public String create(@Parameter(hidden = true) final String apiRequestBodyAsJson) {

        final CommandWrapper commandRequest = new CommandWrapperBuilder() //
                .createUser() //
                .withJson(apiRequestBodyAsJson) //
                .build();

        final CommandProcessingResult result = this.commandsSourceWritePlatformService.logCommandSource(commandRequest);

        return this.toApiJsonSerializer.serialize(result);
Create a CommandWrapper object that represents this create user command and JSON request body. Pass off responsiblity for processing to PortfolioCommandSourceWritePlatformService.logCommandSource
            // maker checker doesnt mean anything here.
            isApprovedByChecker = true; // set to true in case permissions have
                                        // been maker-checker enabled by
                                        // accident.
        } else {
            // if not user changing their own details - check user has
            // permission to perform specific task.
            this.context.authenticatedUser(wrapper).validateHasPermissionTo(wrapper.getTaskPermissionName());
        }
        validateIsUpdateAllowed();

        final String json = wrapper.getJson();
        CommandProcessingResult result = null;
        JsonCommand command = null;
        int numberOfRetries = 0;
        int maxNumberOfRetries = ThreadLocalContextUtil.getTenant().getConnection().getMaxRetriesOnDeadlock();
        int maxIntervalBetweenRetries = ThreadLocalContextUtil.getTenant().getConnection().getMaxIntervalBetweenRetries();
        final JsonElement parsedCommand = this.fromApiJsonHelper.parse(json);
        command = JsonCommand.from(json, parsedCommand, this.fromApiJsonHelper, wrapper.getEntityName(), wrapper.getEntityId(),
                wrapper.getSubentityId(), wrapper.getGroupId(), wrapper.getClientId(), wrapper.getLoanId(), wrapper.getSavingsId(),
                wrapper.getTransactionId(), wrapper.getHref(), wrapper.getProductId(), wrapper.getCreditBureauId(),
                wrapper.getOrganisationCreditBureauId());
        while (numberOfRetries <= maxNumberOfRetries) {
            try {
                result = this.processAndLogCommandService.processAndLogCommand(wrapper, command, isApprovedByChecker);
                numberOfRetries = maxNumberOfRetries + 1;
            } catch (CannotAcquireLockException | ObjectOptimisticLockingFailureException exception) {
                log.info("The following command {} has been retried  {} time(s)", command.json(), numberOfRetries);
                /***
                 * Fail if the transaction has been retired for maxNumberOfRetries
                 **/
                if (numberOfRetries >= maxNumberOfRetries) {
                    log.warn("The following command {} has been retried for the max allowed attempts of {} and will be rolled back",
                            command.json(), numberOfRetries);
                    throw exception;
                }
                /***
                 * Else sleep for a random time (between 1 to 10 seconds) and continue
                 **/
                try {
                    int randomNum = RANDOM.nextInt(maxIntervalBetweenRetries + 1);
                    Thread.sleep(1000 + (randomNum * 1000));
                    numberOfRetries = numberOfRetries + 1;
                } catch (InterruptedException e) {
                    throw exception;
                }
            } catch (final RollbackTransactionAsCommandIsNotApprovedByCheckerException e) {
                numberOfRetries = maxNumberOfRetries + 1;
                result = this.processAndLogCommandService.logCommand(e.getCommandSourceResult());
            }
        }

        return result;
    }

    @Override
    public CommandProcessingResult approveEntry(final Long makerCheckerId) {

        final CommandSource commandSourceInput = validateMakerCheckerTransaction(makerCheckerId);
        validateIsUpdateAllowed();
Check user has permission for this action. if ok, a) parse the json request body, b) create a JsonCommand object to wrap the command details, c) use CommandProcessingService to handle command
        final AppUser maker = this.context.authenticatedUser(wrapper);

        CommandSource commandSourceResult = null;
        if (command.commandId() != null) {
            commandSourceResult = this.commandSourceRepository.findById(command.commandId()).orElse(null);
            commandSourceResult.markAsChecked(maker, ZonedDateTime.now(DateUtils.getDateTimeZoneOfTenant()));
        } else {
            commandSourceResult = CommandSource.fullEntryFrom(wrapper, command, maker);
        }
        commandSourceResult.updateResourceId(result.resourceId());
        commandSourceResult.updateForAudit(result.getOfficeId(), result.getGroupId(), result.getClientId(), result.getLoanId(),
                result.getSavingsId(), result.getProductId(), result.getTransactionId());

        String changesOnlyJson = null;
        boolean rollBack = (rollbackTransaction || result.isRollbackTransaction()) && !isApprovedByChecker;
        if (result.hasChanges() && !rollBack) {
            changesOnlyJson = this.toApiJsonSerializer.serializeResult(result.getChanges());
            commandSourceResult.updateJsonTo(changesOnlyJson);
        }

        if (!result.hasChanges() && wrapper.isUpdateOperation() && !wrapper.isUpdateDatatable()) {
            commandSourceResult.updateJsonTo(null);
        }

        if (commandSourceResult.hasJson()) {
            this.commandSourceRepository.save(commandSourceResult);
        }

        if ((rollbackTransaction || result.isRollbackTransaction()) && !isApprovedByChecker) {
            /*
             * JournalEntry will generate a new transactionId every time. Updating the transactionId with old
             * transactionId, because as there are no entries are created with new transactionId, will throw an error
             * when checker approves the transaction
             */
            commandSourceResult.updateTransaction(command.getTransactionId());
            /*
             * Update CommandSource json data with JsonCommand json data, line 77 and 81 may update the json data
             */
            commandSourceResult.updateJsonTo(command.json());
            throw new RollbackTransactionAsCommandIsNotApprovedByCheckerException(commandSourceResult);
        }
        result.setRollbackTransaction(null);

        publishEvent(wrapper.entityName(), wrapper.actionName(), command, result);

        return result;
    }

    @Transactional
    @Override
    public CommandProcessingResult logCommand(CommandSource commandSourceResult) {

        commandSourceResult.markAsAwaitingApproval();
        commandSourceResult = this.commandSourceRepository.saveAndFlush(commandSourceResult);

        return new CommandProcessingResultBuilder().withCommandId(commandSourceResult.getId())
                .withEntityId(commandSourceResult.getResourceId()).build();
    }

    private NewCommandSourceHandler findCommandHandler(final CommandWrapper wrapper) {
        NewCommandSourceHandler handler = null;

        if (wrapper.isDatatableResource()) {
            if (wrapper.isCreateDatatable()) {
                handler = this.applicationContext.getBean("createDatatableCommandHandler", NewCommandSourceHandler.class);
            } else if (wrapper.isDeleteDatatable()) {
if a RollbackTransactionAsCommandIsNotApprovedByCheckerException occurs at this point. The original transaction will of been aborted and we only log an entry for the command in the audit table setting its status as 'Pending'.
  • Check that if maker-checker configuration enabled for this action. If yes and this is not a 'checker' approving the command - rollback at the end. We rollback at the end in order to test if the command will pass 'domain validation' which requires commit to database for full check.

  • findCommandHandler - Find the correct Hanlder to process this command.

  • Process command using handler (In transactional scope).

  • CommandSource object created/updated with all details for logging to 'm_portfolio_command_source' table.

  • In update scenario, we check to see if there where really any changes/updates. If so only JSON for changes is stored in audit log.

Persistence

TBD

Database support

Fineract supports multiple databases:

  • MySQL compatible databases (e.g. MariaDB)

  • PostgreSQL

The platform differentiates between these database types in certain cases when there’s a need to use some database specific tooling. To do so, the platform examines the JDBC driver used for running the platform and tries to determine which database is being used.

The currently supported JDBC driver and corresponding mappings can be found below.

JDBC driver class name

Resolved database type

org.mariadb.jdbc.Driver

MySQL

com.mysql.jdbc.Driver

MySQL

org.postgresql.Driver

PostgreSQL

The actual code can be found in the DatabaseTypeResolver class.

Data-access layer

The data-access layer of Fineract is implemented by using JPA (Java Persistence API) with the EclipseLink provider.
Despite the fact that JPA is used quite extensively in the system, there are cases where the performance is a key element for an operation therefore you can easily find native SQLs as well.

The data-access layer of Fineract is compatible with different databases. Since a lot of the native queries are using specific database functions, a wrapper class - DatabaseSpecificSQLGenerator - has been introduced to handle these database specifics. Whenever there’s a need to rely on new database level functions, make sure to extend this class and implement the specific functions provided by the database.

Fineract has been developed for 10+ years by the community and unfortunately there are places where entity relationships are configured with EAGER fetching strategy. This must not confuse anybody. The long-term goal is to use the LAZY fetching strategy for every single relationship. If you’re about to introduce a new one, make sure to use LAZY as a fetching strategy, otherwise your PR will be rejected.

Database schema migration

As for every system, the database structure will and need to evolve over time. Fineract is no different. Originally for Fineract, Flyway was used until Fineract 1.6.x.

After 1.6.x, PostgreSQL support was added to the platform hence there was a need to make the data-access layer and the schema migration as database independent as possible. Becuase of that, from Fineract 1.7.0, Flyway is not used anymore but Liquibase is.

Some of the changesets in the Liquibase changelogs have database specifics into it but they only run for the relevant databases. This is controller by Liquibase contexts.

The currently available Liquibase contexts are:

  • mysql - only set when the database is a MySQL compatible database (e.g. MariaDB)

  • postgresql - only set when the database is a PostgreSQL database

  • configured Spring active profiles

  • tenant_store_db - only set when the database migration runs the Tenant Store upgrade

  • tenant_db - only set when the database migration runs the Tenant upgrade

  • initial_switch - this is a technical context and should NOT be used

The switch from Flyway (1.6.x) to Liquibase (1.7.x) was planned to be as smooth as possible so there’s no need for manual work hence the behavior is described as following:

  • If the database is empty, Liquibase will create the database schema from scratch

  • If the database contains the latest Fineract 1.6.x database structure which was previously migrated with Flyway. Liquibase will seamlessly upgrade it to the latest version. Note: the Flyway related 2 database tables are left as they are and are not deleted.

  • If the database contains an earlier version of the database structure than Fineract 1.6.x. Liquibase will NOT do anything and will fail the application during startup. The proper approach in this case is to first upgrade your application version to the latest Fineract 1.6.x so that the latest Flyway changes are executed and then upgrade to the newer Fineract version where Liquibase will seamlessly take over the database upgrades.

Validation

Programmatic

Use the DataValidatorBuilder, e.g. like so:

new DataValidatorBuilder().resource("fileUpload")
    .reset().parameter("Content-Length").value(contentLength).notBlank().integerGreaterThanNumber(0)
    .reset().parameter("FormDataContentDisposition").value(fileDetails).notNull()
    .throwValidationErrors();

Such code is often encapsulated in *Validator classes (if more than a few lines, and/or reused from several places; avoid copy/paste), like so:

public class YourThingValidator {

    public void validate(YourThing thing) {
        new DataValidatorBuilder().resource("yourThing")
        ...
        .throwValidationErrors();
    }
}

Declarative

[FINERACT-1229](issues.apache.org/jira/browse/FINERACT-1229) is an open issue about adopting Bean Validation for declarative instead of programmatic (as above) validation. Contributions welcome!

Technology

TBD

Modules

Currently modules are a proof of concept feature in Fineract.

How to create a Fineract module

At the moment the only module we have that follows these stricter guidelines is the example module we describe in detail in the next section. In the future we will try to split up Fineract’s monolithic code base and move features (like loan product, accounts etc.) to separate modules as described here. Before that happens we need to do some code cleanups first.
  1. Create a folder under module and name it mymodule.

  2. Create a folder named core under module/mymodule.

  3. Create a folder named service under module/mymodule.

  4. Create a folder named starter under module/mymodule.

  5. Setup folders and Gradle build files for a Java project under core, service and starter.

  6. Create a text file called _spring.factories in folder modules/mymodule/starter/src/main/resources/META-INF.

    The final folder and file structure should look somewhat like this:

    Diagram
  7. Make sure that your new modules are present in settings.gradle:

    rootProject.name='fineract'
    include ':module:mymodule:core' (1)
    include ':module:mymodule:service'
    include ':module:mymodule:starter'
    include ':fineract-provider'
    include ':fineract-war'
    include ':integration-tests'
    include ':twofactor-tests'
    include ':oauth2-tests'
    include ':fineract-client'
    include ':fineract-doc'
    1 The settings.gradle file should contain something like this (and following).

How to replace an existing Fineract service

Creating customizations for Fineract services is easy. The method described here will work both with our future module guidelines (aka "clean room" modules) and with the intermediary solution we will put in place to avoid major refactorings.

You can of course choose whatever folder/project structure you like for your custom modules. But we’ll describe here some best practices to avoid merge conflicts when fetching updates from Fineract’s upstream Git repository. For the time being we suggest to create your custom modules in the same folder as Fineract in a forked Git repo.

As soon as we can publish Fineract module JARs to Maven Central you’ll have more freedom to setup your projects (including to setup separate Git repos).

  1. Create a folder under custom and name it mycustom.

  2. Create a folder named service under custom/mycustom.

  3. Setup folders and Gradle build files for a Java project under service.

  4. Create a text file called _spring.factories in folder modules/mymodule/starter/src/main/resources/META-INF:

    org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
     org.apache.fineract.mymodule.starter.MyAutoConfiguration

    The final folder and file structure should look somewhat like this:

    Diagram

    Please make sure that your service module’s build.gradle file has a unique group:

    description = 'My Company: Fineract My Custom Service'
    
    group = 'com.mycompany.fineract.custom.service' (1)
    
    apply from: 'dependencies.gradle'
    1 The best choice here is to name it like you would name your JAR artifact on Maven Central.
  5. Make sure that your custom modules are present in settings.gradle: :

    rootProject.name='fineract'
    include ':custom:mycustom:service' (1)
    include ':fineract-provider'
    include ':fineract-war'
    include ':integration-tests'
    include ':twofactor-tests'
    include ':oauth2-tests'
    include ':fineract-client'
    include ':fineract-doc'
    1 The settings.gradle file should contain something like this.
  6. The dependency.gradle file could look something like this:

dependencies {
    implementation(project(':module:mymodule:core'), (1)
            'org.springframework:spring-context')
    compileOnly project(':fineract-provider') (2)
}
1 If you are replacing a "clean room" module then you just need to include a dependency on the modules core library.
2 If you are replacing a service that is not yet extracted from fineract-provider then you need to add a dependency on it (only needed during compilation).
  1. When the custom module is built then you can add the JAR in your Fineract’s libs folder (or in Tomcat’s libs folder if you are deploying as a WAR app).

Do not include your custom module in `fineract-provider’s dependency.gradle file. This creates a circular dependency and will fail your build. Instead you have to add your JAR file e. g. to the Docker image (in Fineract’s libs folder; similar like we do it with Pentaho reporting). This setup will give you the best developer experience for now with proper source references until we have separate JAR files ready on Maven Central. In the next section we describe the "clean room" (read: where we want to go) type of modules and their customization/replacement; so don’t be confused if you see the dependency appearing in `fineract-provider’s dependency.gradle, in the future you’ll be able to do that.

Example

Dummy Module Structure

We’ve created a demonstration how modules are supposed to be used. A module has usually at least two sub-modules:

  1. a core module that contains mostly Java interfaces of the services and/or other components that we’d like to make replacable. The core module could also contain data (DTO) or domain (entity) classes if necessary.

  2. a service module

Replacing parts of the existing REST API and extending it with custom endpoints is at the moment out of scope. Probably we’ll need to cleanup and improve the REST layer quite a bit (remove boilerplate code as much as possible, use Jackson for JSON de-/serialization instead of the manual GSON mappers/helper everywhere) before this can happen. For now we’ll concentrate primarily on service classes.

Let’s assume we have a service DummyService in our system. The service is outlined as a Java interface in module folder module/dummy/core.

package org.apache.fineract.dummy.core.service;

import org.apache.fineract.dummy.core.data.DummyMessage;

public interface DummyService {

    DummyMessage getMessage();
}

To make it a little bit more interesting the service’s only function returns a simple data object that has one string attribute:

package org.apache.fineract.dummy.core.data;

public class DummyMessage {

    private String message;

    public DummyMessage(String message) {
        this.message = message;
    }

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }
}

A default implementation of DummyService is provided with DummyServiceImpl:

package org.apache.fineract.dummy.service;

import org.apache.fineract.dummy.core.data.DummyMessage;
import org.apache.fineract.dummy.core.service.DummyService;

public class DummyServiceImpl implements DummyService {

    @Override
    public DummyMessage getMessage() {
        return new DummyMessage("Hello: DEFAULT DUMMY!");
    }
}

As you can see there are no annotations like @Service or @Component. To have full control over the instantiation and dependency injection we provide a so called starter module. This module just contains one or more (auto-) configuration classes. In this case it’s just one configuration class. This is basically a very simple Spring Java configuration class annotated with @Configuration containing one method that instantiates our default service implementation (annotated with @Bean):

package org.apache.fineract.dummy.starter;

import org.apache.fineract.dummy.core.service.DummyService;
import org.apache.fineract.dummy.service.DummyServiceImpl;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
@ConditionalOnMissingBean(DummyService.class)
public class DummyAutoConfiguration {

    @Bean
    public DummyService dummyService() {
        return new DummyServiceImpl();
    }
}

The interesting part is this line:

@ConditionalOnMissingBean(DummyService.class)

This annotation ensures that our default implementation is only instantiated if no other implementation for DummyService is provided. There’s only one piece missing to make auto configuration work seamlessly and without any explicit configuration in fineract-provider:

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
 org.apache.fineract.dummy.starter.DummyAutoConfiguration

This means if we would only include the following dependencies in our main project (e. g. fineract-provider)…​

dependencies {
    implementation project(':module:dummy:core')
    implementation project(':module:dummy:service')
    implementation project(':module:dummy:starter')
}

... then the message object would contain

Hello: DEFAULT DUMMY!
Replace the default implementation of DummyService

This is why we created module foo in folder module/foo. There’s only only one sub-module that contains an implementation of DummyService that will replace the default implementation:

package com.acmecorp.fineract.foo.service;

import org.apache.fineract.dummy.core.data.DummyMessage;
import org.apache.fineract.dummy.core.service.DummyService;
import org.springframework.stereotype.Service;

@Service
public class FooDummyServiceImpl implements DummyService {

    @Override
    public DummyMessage getMessage() {
        return new DummyMessage("Hello: FOO!");
    }
}

As you can see we have no other sub-modules (e. g. there’s no starter module) and this implementation contains the well known @Service annotation. If we add this dependency to our main project…​

dependencies {
    implementation project(':module:dummy:core')
    implementation project(':module:dummy:service')
    implementation project(':module:dummy:starter')
    implementation project(':custom:foo:service')
}

... then the expected behavior is that we’ll get the message

Hello: Foo!
Testing

There’s a simple unit test in fineract-provider that demonstrates both scenarios (without any override of the default implementation and with an overriding alternative implementation)

Feature: Example Modules

  @modules
  Scenario Outline: Verify that the dummy service returns the correct message
    Given A dummy service configuration <configurationClass>
    When The user gets the dummy service message
    Then The dummy service message should match <message>

    Examples:
      | configurationClass                                          | message               |
      | org.apache.fineract.module.example.TestDefaultConfiguration | Hello: DEFAULT DUMMY! |
      | org.apache.fineract.module.example.TestFooConfiguration     | Hello: FOO!           |

Here’s the Spring Java configuration that does NOT load the foo module:

package org.apache.fineract.module.example;

import org.apache.fineract.infrastructure.core.config.FineractProperties;
import org.springframework.boot.context.properties.EnableConfigurationProperties;

@EnableConfigurationProperties({ FineractProperties.class })
public class TestDefaultConfiguration {}

... and here’s the configuration that loads the foo module (and overrides the deefault implementation)

package org.apache.fineract.module.example;

import org.apache.fineract.infrastructure.core.config.FineractProperties;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.ComponentScan;

@EnableConfigurationProperties({ FineractProperties.class })
@ComponentScan("com.acmecorp.fineract.foo")
public class TestFooConfiguration {}

The important part in the foo configuration is this line:

@ComponentScan("com.acmecorp.fineract.foo")
Deployment

Modules (better: the JAR files) only need to be dropped in Fineract’s libs folder. Dynamic loading of external JARs is provided since Fineract version 1.5.0.

How can I start replacing services now

As said the "clean room" modules will take a while to arrive. In the meanwhile we’ll prepare the existing monolithic code base for pluggability. As a proof of concept the services org.apache.fineract.portfolio.note.service.NoteReadPlatformService and org.apache.fineract.portfolio.note.service.NoteWritePlatformService can be replaced/overriden by custom implementations. We’ll add more shortly and will list them here. Reach out on the mailing list if you need a specific service to be replaceable.

Outlook

If this proof of concept is accepted we could refactor Fineract’s services one by one and rearrange them in the proposed module structure. As discussed at ApacheCon 2021 there will be most likely some work to do to properly extract those modules (loan product, client, savings account etc.) from the monolithic code base. The main challenge are cross-dependencies between the modules, but there are major benefits if we split up the code like this. One - as demonstrated - is the replacement of existing default functionality. But with modules we’ll also be able to finally publish Fineract JAR files to Maven Central. Those JAR files can be used to write extensions and customizations WITHOUT forking the whole Fineract Github repository. With modules users will also be able to create custom Fineract distributions, e. g. slimmed down to contain only the bare minimum needed in production.

Fineract Development Environment

TBD

Git

TBD

GPG

TBD

Committers

Please make sure to provide your GPG fingerprint in your Apache committer profile at id.apache.org.

Docker

TBD

Docker Compose

TBD

Podman

TBD

Rancher Docker Desktop

TBD

Gradle

TBD

IDE

TBD

IntelliJ

TBD

Eclipse

TBD

VSCode

TBD

Kubernetes

TBD

Minikube

TBD

Microk8s

TBD

K3d

TBD

Helm Charts

TBD

Tools

TBD

SDKMAN

We recommend using SKDMAN to manage the following developer tools:

  • JDK

  • Spring Boot CLI

  • Gradle (if you need a global installation)

  • AsciidoctorJ

TBD

Brew

MacOS

TBD

Linux

TBD

Security

TBD

OAuth

Fineract has a (basic) OAuth2 support based on Spring Boot Security. Here’s how to use it:

Build

You must re-build the distribution JAR (or WAR) using the special -Psecurity=oauth flag:

./gradlew bootRun -Psecurity=oauth

Downloads from fineract.apache.org, or using e.g. the hub.docker.com/r/apache/fineract container image, or on www.fineract.dev, this will not work, because they have not been built using this flag.

Previous versions of Fineract included a built-in authorisation server for issuing OAuth tokens. However, as the spring-security-oauth2 package was deprecated and replaced by built-in OAuth support in Spring Security, this is no longer supported as part of the package. Instead, you need to run a separate OAuth authorization server (e.g. github.com/spring-projects/spring-authorization-server) or use a 3rd-party OAuth authorization provider (en.wikipedia.org/wiki/List_of_OAuth_providers)

This instruction describes how to get Fineract OAuth working with a Keycloak (keycloak.org) based authentication provider running in a Docker container. The steps required for other OAuth providers will be similar.

Set up Keycloak

  1. From terminal, run: 'docker run -p 9000:8080 -e KEYCLOAK_USER=admin -e KEYCLOAK_PASSWORD=admin quay.io/keycloak/keycloak:15.0.2'

  2. Go to URL 'http://localhost:9000/auth/admin' and login with admin/admin

  3. Hover your mouse over text "Master" and click on "Add realm"

  4. Enter name "fineract" for your realm

  5. Click on tab "Users" on the left, then "Add user" and create user with username "mifos"

  6. Click on tab "Credentials" at the top, and set password to "password", turning "temporary" setting to off

  7. Click on tab "Clients" on the left, and create client with ID 'community-app'

  8. In settings tab, set 'access-type' to 'confidential' and enter 'localhost' in the valid redirect URIs.

  9. In credentials tab, copy string in field 'secret' as this will be needed in the step to request the access token

Finally we need to change Keycloak configuration so that it uses the username as a subject of the token:

  1. Choose client 'community-app' in the tab 'Clients'

  2. Go to tab 'Mappers' and click on 'Create'

  3. Enter 'usernameInSub' as 'Name'

  4. Choose mapper type 'User Property'

  5. Enter 'username' into the field 'Property' and 'sub' into the field 'Token Claim Name'. Choose 'String' as 'Claim JSON Type'

You are now ready to test out OAuth:

Retrieve an access token from Keycloak

curl --location --request POST \
'http://localhost:9000/auth/realms/fineract/protocol/openid-connect/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'username=mifos' \
--data-urlencode 'password=password' \
--data-urlencode 'client_id=community-app' \
--data-urlencode 'grant_type=password' \
--data-urlencode 'client_secret=<enter the client secret from credentials tab>'

The reply should contain a field 'access_token'. Copy the field’s value and use it in the API call below:

Invoke APIs and pass Authorization: bearer …​ header

curl --location --request GET \
'https://localhost:8443/fineract-provider/api/v1/offices' \
--header 'Fineract-Platform-TenantId: default' \
--header 'Authorization: bearer <enter the value of the access_token field>'

OpenAPI Sample description

Abstract
A sample OpenAPI documentation

.1. Endpoints

.1.1. AccountNumberFormat

create

POST /accountnumberformats

Create an Account number format

Description

Note: You may associate a single Account number format for a given account type Mandatory Fields for Account number formats accountType

Parameters
Body Parameter
Name Description Required Default Pattern

PostAccountNumberFormatsRequest

Section .2.781

-

Return Type
Content Type
  • application/json

Responses
Table 3. http response codes
Code Message Datatype

200

OK

Section .2.782

Samples
delete

DELETE /accountnumberformats/{accountNumberFormatId}

Delete an Account number format

Description

Note: Account numbers created while this format was active would remain unchanged.

Parameters
Path Parameters
Name Description Required Default Pattern

accountNumberFormatId

accountNumberFormatId

X

null

Return Type
Content Type
  • application/json

Responses
Table 4. http response codes
Code Message Datatype

200

OK

Section .2.26

Samples
retrieveAll3

GET /accountnumberformats

List Account number formats

Description

Example Requests: accountnumberformats accountnumberformats?fields=accountType,prefixType

Parameters
Return Type

array[Section .2.86]

Content Type
  • application/json

Responses
Table 5. http response codes
Code Message Datatype

200

OK

List[Section .2.86]

Samples
retrieveOne

GET /accountnumberformats/{accountNumberFormatId}

Retrieve an Account number format

Description

Example Requests: accountnumberformats/1 accountnumberformats/1?template=true accountnumberformats/1?fields=accountType,prefixType

Parameters
Path Parameters
Name Description Required Default Pattern

accountNumberFormatId

accountNumberFormatId

X

null

Return Type
Content Type
  • application/json

Responses
Table 6. http response codes
Code Message Datatype

200

OK

Section .2.86

Samples
retrieveTemplate2

GET /accountnumberformats/template

Retrieve Account number format Template

Description

This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults Allowed Value Lists Example Request: accountnumberformats/template

Parameters
Return Type
Content Type
  • application/json

Responses
Table 7. http response codes
Code Message Datatype

200

OK

Section .2.87

Samples
update1

PUT /accountnumberformats/{accountNumberFormatId}

Update an Account number format

Description
Parameters
Path Parameters
Name Description Required Default Pattern

accountNumberFormatId

accountNumberFormatId

X

null

Body Parameter
Name Description Required Default Pattern

PutAccountNumberFormatsRequest

Section .2.987

X

Return Type
Content Type
  • application/json

Responses
Table 8. http response codes
Code Message Datatype

200

OK

Section .2.988

Samples

.1.2. AccountTransfers

create4

POST /accounttransfers

Create new Transfer

Description

Ability to create new transfer of monetary funds from one account to another.

Parameters
Body Parameter
Name Description Required Default Pattern

PostAccountTransfersRequest

Section .2.785

X

Return Type
Content Type
  • application/json

Responses
Table 9. http response codes
Code Message Datatype

200

OK

Section .2.786

Samples
retrieveAll18

GET /accounttransfers

List account transfers

Description

Lists account’s transfers Example Requests: accounttransfers

Parameters
Query Parameters
Name Description Required Default Pattern

sqlSearch

sqlSearch

-

null

externalId

externalId

-

null

offset

offset

-

null

limit

-

null

orderBy

orderBy

-

null

sortOrder

sortOrder

-

null

accountDetailId

accountDetailId

-

null

Return Type
Content Type
  • application/json

Responses
Table 10. http response codes
Code Message Datatype

200

OK

Section .2.102

Samples
retrieveOne9

GET /accounttransfers/{transferId}

Retrieve account transfer

Description

Retrieves account transfer Example Requests : accounttransfers/1

Parameters
Path Parameters
Name Description Required Default Pattern

transferId

transferId

X

null

Return Type
Content Type
  • application/json

Responses
Table 11. http response codes
Code Message Datatype

200

OK

Section .2.97

Samples
template5

GET /accounttransfers/template

Retrieve Account Transfer Template

Description

This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults Allowed Value Lists Example Requests: accounttransfers/template?fromAccountType=2&fromOfficeId=1 accounttransfers/template?fromAccountType=2&fromOfficeId=1&fromClientId=1 accounttransfers/template?fromClientId=1&fromAccountType=2&fromAccountId=1

Parameters
Query Parameters
Name Description Required Default Pattern

fromOfficeId

fromOfficeId

-

null

fromClientId

fromClientId

-

null

fromAccountId

fromAccountId

-

null

fromAccountType

fromAccountType

-

null

toOfficeId

toOfficeId

-

null

toClientId

toClientId

-

null

toAccountId

toAccountId

-

null

toAccountType

toAccountType

-

null

Return Type
Content Type
  • application/json

Responses
Table 12. http response codes
Code Message Datatype

200

OK

Section .2.114

Samples
templateRefundByTransfer

GET /accounttransfers/templateRefundByTransfer

Retrieve Refund of an Active Loan by Transfer Template

Description

Retrieves Refund of an Active Loan by Transfer TemplateExample Requests : accounttransfers/templateRefundByTransfer?fromAccountId=2&fromAccountType=1& toAccountId=1&toAccountType=2&toClientId=1&toOfficeId=1

Parameters
Query Parameters
Name Description Required Default Pattern

fromOfficeId

fromOfficeId

-

null

fromClientId

fromClientId

-

null

fromAccountId

fromAccountId

-

null

fromAccountType

fromAccountType

-

null

toOfficeId

toOfficeId

-

null

toClientId

toClientId

-

null

toAccountId

toAccountId

-

null

toAccountType

toAccountType

-

null

Return Type
Content Type
  • application/json

Responses
Table 13. http response codes
Code Message Datatype

200

OK

Section .2.111

Samples
templateRefundByTransferPost

POST /accounttransfers/refundByTransfer

Refund of an Active Loan by Transfer

Description

Ability to refund an active loan by transferring to a savings account.

Parameters
Body Parameter
Name Description Required Default Pattern

PostAccountTransfersRefundByTransferRequest

Section .2.783

X

Return Type
Content Type
  • application/json

Responses
Table 14. http response codes
Code Message Datatype

200

OK

Section .2.784

Samples

.1.3. AccountingClosure

createGLClosure

POST /glclosures

Create an Accounting Closure

Description

Mandatory Fields officeId,closingDate

Parameters
Body Parameter
Name Description Required Default Pattern

PostGlClosuresRequest

Section .2.857

X

Return Type
Content Type
  • application/json

Responses
Table 15. http response codes
Code Message Datatype

200

OK

Section .2.858

Samples
deleteGLClosure

DELETE /glclosures/{glClosureId}

Delete an accounting closure

Description

Note: Only the latest accounting closure associated with a branch may be deleted.

Parameters
Path Parameters
Name Description Required Default Pattern

glClosureId

glclosureId

X

null

Return Type
Content Type
  • application/json

Responses
Table 16. http response codes
Code Message Datatype

200

OK

Section .2.46

Samples
retreiveClosure

GET /glclosures/{glClosureId}

Retrieve an Accounting Closure

Description

Example Requests: glclosures/1 /glclosures/1?fields=officeName,closingDate

Parameters
Path Parameters
Name Description Required Default Pattern

glClosureId

glClosureId

X

null

Return Type
Content Type
  • application/json

Responses
Table 17. http response codes
Code Message Datatype

200

OK

Section .2.299

Samples
retrieveAllClosures

GET /glclosures

List Accounting closures

Description

Example Requests: glclosures

Parameters
Query Parameters
Name Description Required Default Pattern

officeId

-

null

Return Type
Content Type
  • application/json

Responses
Table 18. http response codes
Code Message Datatype

200

OK

List[Section .2.299]

Samples
updateGLClosure

PUT /glclosures/{glClosureId}

Update an Accounting closure

Description

Once an accounting closure is created, only the comments associated with it may be edited

Parameters
Path Parameters
Name Description Required Default Pattern

glClosureId

glClosureId

X

null

Body Parameter
Name Description Required Default Pattern

PutGlClosuresRequest

Section .2.1052

-

Return Type
Content Type
  • application/json

Responses
Table 19. http response codes
Code Message Datatype

200

OK

Section .2.1053

Samples

.1.4. AccountingRules

createAccountingRule

POST /accountingrules

Create/Define a Accounting rule

Description

Define a new Accounting rule. Mandatory Fields name, officeId, accountToDebit OR debitTags, accountToCredit OR creditTags. Optional Fields description

Parameters
Body Parameter
Name Description Required Default Pattern

PostAccountingRulesRequest

Section .2.787

-

Return Type
Content Type
  • application/json

Responses
Table 20. http response codes
Code Message Datatype

200

OK

Section .2.788

Samples
deleteAccountingRule

DELETE /accountingrules/{accountingRuleId}

Delete a Accounting Rule

Description

Deletes a Accounting rule.

Parameters
Path Parameters
Name Description Required Default Pattern

accountingRuleId

accountingRuleId

X

null

Return Type
Content Type
  • application/json

Responses
Table 21. http response codes
Code Message Datatype

200

OK

Section .2.27

Samples
retreiveAccountingRule

GET /accountingrules/{accountingRuleId}

Retrieve a Accounting rule

Description

Returns the details of a defined Accounting rule. Example Requests: accountingrules/1

Parameters
Path Parameters
Name Description Required Default Pattern

accountingRuleId

accountingRuleId

X

null

Return Type
Content Type
  • application/json

Responses
Table 22. http response codes
Code Message Datatype

200

OK

Section .2.1

Samples
retrieveAllAccountingRules

GET /accountingrules

Retrieve Accounting Rules

Description

Returns the list of defined accounting rules. Example Requests: accountingrules

Parameters
Return Type

array[Section .2.89]

Content Type
  • application/json

Responses
Table 23. http response codes
Code Message Datatype

200

OK

List[Section .2.89]

Samples
retrieveTemplate1

GET /accountingrules/template

Retrieve Accounting Rule Details Template

Description

This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults Allowed Value Lists Example Request: accountingrules/template

Parameters
Return Type
Content Type
  • application/json

Responses
Table 24. http response codes
Code Message Datatype

200

OK

Section .2.90

Samples
updateAccountingRule

PUT /accountingrules/{accountingRuleId}

Update a Accounting Rule

Description

Updates the details of a Accounting rule.

Parameters
Path Parameters
Name Description Required Default Pattern

accountingRuleId

accountingRuleId

X

null

Body Parameter
Name Description Required Default Pattern

PutAccountingRulesRequest

Section .2.990

-

Return Type
Content Type
  • application/json

Responses
Table 25. http response codes
Code Message Datatype

200

OK

Section .2.991

Samples

.1.5. AdhocQueryApi

createAdHocQuery

POST /adhocquery

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

[string]

-

Return Type
Content Type
  • application/json

Responses
Table 26. http response codes
Code Message Datatype

0

default response

[String]

Samples
deleteAdHocQuery

DELETE /adhocquery/{adHocId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

adHocId

adHocId

X

null

Return Type
Content Type
  • application/json

Responses
Table 27. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveAdHocQuery

GET /adhocquery/{adHocId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

adHocId

adHocId

X

null

Return Type
Content Type
  • application/json

Responses
Table 28. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveAll2

GET /adhocquery

Description
Parameters
Return Type
Content Type
  • application/json

Responses
Table 29. http response codes
Code Message Datatype

0

default response

[String]

Samples
template

GET /adhocquery/template

Description
Parameters
Return Type
Content Type
  • application/json

Responses
Table 30. http response codes
Code Message Datatype

0

default response

[String]

Samples
update

PUT /adhocquery/{adHocId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

adHocId

adHocId

X

null

Body Parameter
Name Description Required Default Pattern

body

[string]

-

Return Type
Content Type
  • application/json

Responses
Table 31. http response codes
Code Message Datatype

0

default response

[String]

Samples

.1.6. Audits

retrieveAuditEntries

GET /audits

List Audits

Description

Get a 200 list of audits that match the criteria supplied and sorted by audit id in descending order, and are within the requestors' data scope. Also it supports pagination and sorting Example Requests: audits audits?fields=madeOnDate,maker,processingResult audits?makerDateTimeFrom=2013-03-25 08:00:00&makerDateTimeTo=2013-04-04 18:00:00 audits?officeId=1 audits?officeId=1&includeJson=true

Parameters
Query Parameters
Name Description Required Default Pattern

actionName

actionName

-

null

entityName

entityName

-

null

resourceId

resourceId

-

null

makerId

makerId

-

null

makerDateTimeFrom

makerDateTimeFrom

-

null

makerDateTimeTo

makerDateTimeTo

-

null

checkerId

checkerId

-

null

checkerDateTimeFrom

checkerDateTimeFrom

-

null

checkerDateTimeTo

checkerDateTimeTo

-

null

processingResult

processingResult

-

null

officeId

officeId

-

null

groupId

groupId

-

null

clientId

clientId

-

null

loanid

loanid

-

null

savingsAccountId

savingsAccountId

-

null

paged

paged

-

null

offset

offset

-

null

limit

limit

-

null

orderBy

orderBy

-

null

sortOrder

sortOrder

-

null

Return Type
Content Type
  • application/json

Responses
Table 32. http response codes
Code Message Datatype

200

OK

List[Section .2.443]

Samples
retrieveAuditEntry

GET /audits/{auditId}

Retrieve an Audit Entry

Description

Example Requests: audits/20 audits/20?fields=madeOnDate,maker,processingResult

Parameters
Path Parameters
Name Description Required Default Pattern

auditId

auditId

X

null

Return Type
Content Type
  • application/json

Responses
Table 33. http response codes
Code Message Datatype

200

OK

Section .2.443

Samples
retrieveAuditSearchTemplate

GET /audits/searchtemplate

Audit Search Template

Description

This is a convenience resource. It can be useful when building an Audit Search UI. \"appUsers\" are data scoped to the office/branch the requestor is associated with. Example Requests: audits/searchtemplate audits/searchtemplate?fields=actionNames

Parameters
Return Type
Content Type
  • application/json

Responses
Table 34. http response codes
Code Message Datatype

200

OK

Section .2.444

Samples

.1.7. AuthenticationHTTPBasic

authenticate

POST /authentication

Verify authentication

Description

Authenticates the credentials provided and returns the set roles and permissions allowed.

Parameters
Body Parameter
Name Description Required Default Pattern

PostAuthenticationRequest

Section .2.797

X

Query Parameters
Name Description Required Default Pattern

returnClientList

-

false

Return Type
Content Type
  • application/json

Responses
Table 35. http response codes
Code Message Datatype

200

OK

Section .2.798

400

Unauthenticated. Please login

<<>>

Samples

.1.8. BatchAPI

handleBatchRequests

POST /batches

Batch requests in a single transaction

Description

The Apache Fineract Batch API is also capable of executing all the requests in a single transaction, by setting a Query Parameter, \"enclosingTransaction=true\". So, if one or more of the requests in a batch returns an erroneous response all of the Data base transactions made by other successful requests will be rolled back. If there has been a rollback in a transaction then a single response will be provided, with a '400' status code and a body consisting of the error details of the first failed request.

Parameters
Body Parameter
Name Description Required Default Pattern

PostBatchesRequest

Section .2.799

X

Query Parameters
Name Description Required Default Pattern

enclosingTransaction

enclosingTransaction

-

false

Return Type
Content Type
  • application/json

Responses
Table 36. http response codes
Code Message Datatype

200

Success

Section .2.6

Samples

.1.9. BulkImport

getOutputTemplate

GET /imports/downloadOutputTemplate

Description
Parameters
Query Parameters
Name Description Required Default Pattern

importDocumentId

-

null

Return Type

-

Content Type
  • application/vnd.ms-excel

Responses
Table 37. http response codes
Code Message Datatype

0

default response

<<>>

Samples
retrieveImportDocuments

GET /imports

Description
Parameters
Query Parameters
Name Description Required Default Pattern

entityType

-

null

Return Type
Content Type
  • application/json

Responses
Table 38. http response codes
Code Message Datatype

0

default response

[String]

Samples
retriveOutputTemplateLocation

GET /imports/getOutputTemplateLocation

Description
Parameters
Query Parameters
Name Description Required Default Pattern

importDocumentId

-

null

Return Type
Content Type
  • /

Responses
Table 39. http response codes
Code Message Datatype

0

default response

[String]

Samples

.1.10. BulkLoans

loanReassignment

POST /loans/loanreassignment

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

[string]

-

Return Type
Content Type
  • application/json

Responses
Table 40. http response codes
Code Message Datatype

0

default response

[String]

Samples
loanReassignmentTemplate

GET /loans/loanreassignment/template

Description
Parameters
Query Parameters
Name Description Required Default Pattern

officeId

-

null

fromLoanOfficerId

-

null

Return Type
Content Type
  • application/json

Responses
Table 41. http response codes
Code Message Datatype

0

default response

[String]

Samples

.1.11. Cache

retrieveAll4

GET /caches

Retrieve Cache Types

Description

Returns the list of caches. Example Requests: caches

Parameters
Return Type
Content Type
  • application/json

Responses
Table 42. http response codes
Code Message Datatype

200

OK

List[Section .2.141]

Samples
switchCache

PUT /caches

Switch Cache

Description

Switches the cache to chosen one.

Parameters
Body Parameter
Name Description Required Default Pattern

PutCachesRequest

Section .2.997

X

Return Type
Content Type
  • application/json

Responses
Table 43. http response codes
Code Message Datatype

200

OK

Section .2.998

Samples

.1.12. Calendar

createCalendar

POST /{entityType}/{entityId}/calendars

Description
Parameters
Path Parameters
Name Description Required Default Pattern

entityType

X

null

entityId

X

null

Body Parameter
Name Description Required Default Pattern

body

[string]

-

Return Type
Content Type
  • application/json

Responses
Table 44. http response codes
Code Message Datatype

0

default response

[String]

Samples
deleteCalendar

DELETE /{entityType}/{entityId}/calendars/{calendarId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

entityType

X

null

entityId

X

null

calendarId

X

null

Return Type
Content Type
  • application/json

Responses
Table 45. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveCalendar

GET /{entityType}/{entityId}/calendars/{calendarId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

calendarId

X

null

entityType

X

null

entityId

X

null

Return Type
Content Type
  • application/json

Responses
Table 46. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveCalendarsByEntity

GET /{entityType}/{entityId}/calendars

Description
Parameters
Path Parameters
Name Description Required Default Pattern

entityType

X

null

entityId

X

null

Query Parameters
Name Description Required Default Pattern

calendarType

-

all

Return Type
Content Type
  • application/json

Responses
Table 47. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveNewCalendarDetails

GET /{entityType}/{entityId}/calendars/template

Description
Parameters
Path Parameters
Name Description Required Default Pattern

entityType

X

null

entityId

X

null

Return Type
Content Type
  • application/json

Responses
Table 48. http response codes
Code Message Datatype

0

default response

[String]

Samples
updateCalendar

PUT /{entityType}/{entityId}/calendars/{calendarId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

entityType

X

null

entityId

X

null

calendarId

X

null

Body Parameter
Name Description Required Default Pattern

body

[string]

-

Return Type
Content Type
  • application/json

Responses
Table 49. http response codes
Code Message Datatype

0

default response

[String]

Samples

.1.13. CashierJournals

getJournalData1

GET /cashiersjournal

Description
Parameters
Query Parameters
Name Description Required Default Pattern

officeId

-

null

tellerId

-

null

cashierId

-

null

dateRange

-

null

Return Type
Content Type
  • application/json

Responses
Table 50. http response codes
Code Message Datatype

0

default response

[String]

Samples

.1.14. Cashiers

getCashierData

GET /cashiers

Description
Parameters
Query Parameters
Name Description Required Default Pattern

officeId

-

null

tellerId

-

null

staffId

-

null

date

-

null

Return Type
Content Type
  • application/json

Responses
Table 51. http response codes
Code Message Datatype

0

default response

[String]

Samples

.1.15. Centers

activate2

POST /centers/{centerId}

Activate a Center | Generate Collection Sheet | Save Collection Sheet | Close a Center | Associate Groups | Disassociate Groups

Description

Activate a Center: Centers can be created in a Pending state. This API exists to enable center activation. If the center happens to be already active, this API will result in an error. Close a Center: Centers can be closed if they don’t have any non-closed groups or saving accounts. If the Center has any active groups or savings accounts, this API will result in an error. Associate Groups: This API allows associating existing groups to a center. The groups are listed from the office to which the center is associated. If group(s) is already associated with a center, this API will result in an error. Disassociate Groups: This API allows to disassociate groups from a center. Generate Collection Sheet: This Api retrieves repayment details of all jlg loans under a center as on a specified meeting date. Save Collection Sheet: This Api allows the loan officer to perform bulk repayments of JLG loans for a center on a given meeting date. Showing Request/Response for Close a Center

Parameters
Path Parameters
Name Description Required Default Pattern

centerId

centerId

X

null

Body Parameter
Name Description Required Default Pattern

PostCentersCenterIdRequest

Section .2.801

X

Query Parameters
Name Description Required Default Pattern

command

command

-

null

Return Type
Content Type
  • application/json

Responses
Table 52. http response codes
Code Message Datatype

200

OK

Section .2.802

Samples
create7

POST /centers

Create a Center

Description

Creates a Center Mandatory Fields: name, officeId, active, activationDate (if active=true) Optional Fields: externalId, staffId, groupMembers

Parameters
Body Parameter
Name Description Required Default Pattern

PostCentersRequest

Section .2.803

X

Return Type
Content Type
  • application/json

Responses
Table 53. http response codes
Code Message Datatype

200

OK

Section .2.804

Samples
delete10

DELETE /centers/{centerId}

Delete a Center

Description

A Center can be deleted if it is in pending state and has no association - groups, loans or savings

Parameters
Path Parameters
Name Description Required Default Pattern

centerId

centerId

X

null

Return Type
Content Type
  • application/json

Responses
Table 54. http response codes
Code Message Datatype

200

OK

Section .2.28

Samples
getCentersTemplate

GET /centers/downloadtemplate

Description
Parameters
Query Parameters
Name Description Required Default Pattern

officeId

-

null

staffId

-

null

dateFormat

-

null

Return Type

-

Content Type
  • application/vnd.ms-excel

Responses
Table 55. http response codes
Code Message Datatype

0

default response

<<>>

Samples
postCentersTemplate

POST /centers/uploadtemplate

Description
Parameters
Form Parameters
Name Description Required Default Pattern

dateFormat

[string]

-

null

locale

[string]

-

null

uploadedInputStream

[file]

-

null

Return Type
Content Type
  • /

Responses
Table 56. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveAll23

GET /centers

List Centers

Description

The default implementation supports pagination and sorting with the default pagination size set to 200 records. The parameter limit with description -1 will return all entries. Example Requests: centers centers?fields=name,officeName,joinedDate centers?offset=10&limit=50 centers?orderBy=name&sortOrder=DESC

Parameters
Query Parameters
Name Description Required Default Pattern

officeId

officeId

-

null

staffId

staffId

-

null

externalId

externalId

-

null

name

name

-

null

underHierarchy

underHierarchy

-

null

paged

paged

-

null

offset

offset

-

null

limit

limit

-

null

orderBy

orderBy

-

null

sortOrder

sortOrder

-

null

meetingDate

meetingDate

-

null

dateFormat

dateFormat

-

null

locale

locale

-

null

Return Type
Content Type
  • application/json

Responses
Table 57. http response codes
Code Message Datatype

200

OK

Section .2.150

Samples
retrieveGroupAccount

GET /centers/{centerId}/accounts

Retrieve Center accounts overview

Description

An example of how a savings summary for a Center can be provided. This is requested in a specific use case of the reference application. It is quite reasonable to add resources like this to simplify User Interface development. Example Requests: centers/9/accounts

Parameters
Path Parameters
Name Description Required Default Pattern

centerId

centerId

X

null

Return Type
Content Type
  • application/json

Responses
Table 58. http response codes
Code Message Datatype

200

OK

Section .2.143

Samples
retrieveOne13

GET /centers/{centerId}

Retrieve a Center

Description

Retrieves a Center Example Requests: centers/1 centers/1?associations=groupMembers

Parameters
Path Parameters
Name Description Required Default Pattern

centerId

centerId

X

null

Query Parameters
Name Description Required Default Pattern

staffInSelectedOfficeOnly

staffInSelectedOfficeOnly

-

false

Return Type
Content Type
  • application/json

Responses
Table 59. http response codes
Code Message Datatype

200

OK

Section .2.145

Samples
retrieveTemplate6

GET /centers/template

Retrieve a Center Template

Description

Retrieves a Center Template Example Requests: centers/template centers/template?officeId=2

Parameters
Query Parameters
Name Description Required Default Pattern

command

command

-

null

officeId

officeId

-

null

staffInSelectedOfficeOnly

staffInSelectedOfficeOnly

-

false

Return Type
Content Type
  • application/json

Responses
Table 60. http response codes
Code Message Datatype

200

OK

Section .2.154

Samples
update11

PUT /centers/{centerId}

Update a Center

Description

Updates a Center

Parameters
Path Parameters
Name Description Required Default Pattern

centerId

centerId

X

null

Body Parameter
Name Description Required Default Pattern

PutCentersCenterIdRequest

Section .2.999

X

Return Type
Content Type
  • application/json

Responses
Table 61. http response codes
Code Message Datatype

200

OK

Section .2.1000

Samples

.1.16. Charges

createCharge

POST /charges

Create/Define a Charge

Description

Define a new charge that can later be associated with loans and savings through their respective product definitions or directly on each account instance.

Parameters
Body Parameter
Name Description Required Default Pattern

PostChargesRequest

Section .2.805

X

Return Type
Content Type
  • application/json

Responses
Table 62. http response codes
Code Message Datatype

200

OK

Section .2.806

Samples
deleteCharge

DELETE /charges/{chargeId}

Delete a Charge

Description

Deletes a Charge.

Parameters
Path Parameters
Name Description Required Default Pattern

chargeId

chargeId

X

null

Return Type
Content Type
  • application/json

Responses
Table 63. http response codes
Code Message Datatype

200

OK

Section .2.29

Samples
retrieveAllCharges

GET /charges

Retrieve Charges

Description

Returns the list of defined charges. Example Requests: charges

Parameters
Return Type
Content Type
  • application/json

Responses
Table 64. http response codes
Code Message Datatype

200

OK

List[Section .2.168]

Samples
retrieveCharge

GET /charges/{chargeId}

Retrieve a Charge

Description

Returns the details of a defined Charge. Example Requests: charges/1

Parameters
Path Parameters
Name Description Required Default Pattern

chargeId

chargeId

X

null

Return Type
Content Type
  • application/json

Responses
Table 65. http response codes
Code Message Datatype

200

OK

Section .2.168

Samples
retrieveNewChargeDetails

GET /charges/template

Retrieve Charge Template

Description

This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults Allowed description Lists Example Request: charges/template

Parameters
Return Type
Content Type
  • application/json

Responses
Table 66. http response codes
Code Message Datatype

200

OK

Section .2.172

Samples
updateCharge

PUT /charges/{chargeId}

Update a Charge

Description

Updates the details of a Charge.

Parameters
Path Parameters
Name Description Required Default Pattern

chargeId

chargeId

X

null

Body Parameter
Name Description Required Default Pattern

PutChargesChargeIdRequest

Section .2.1004

X

Return Type
Content Type
  • application/json

Responses
Table 67. http response codes
Code Message Datatype

200

OK

Section .2.1005

Samples

.1.17. Client

activate1

POST /clients/{clientId}

Activate a Client | Close a Client | Reject a Client | Withdraw a Client | Reactivate a Client | UndoReject a Client | UndoWithdraw a Client | Assign a Staff | Unassign a Staff | Update Default Savings Account | Propose a Client Transfer | Withdraw a Client Transfer | Reject a Client Transfer | Accept a Client Transfer | Propose and Accept a Client Transfer

Description

Activate a Client: Clients can be created in a Pending state. This API exists to enable client activation (for when a client becomes an approved member of the financial Institution). If the client happens to be already active this API will result in an error. Close a Client: Clients can be closed if they do not have any non-closed loans/savingsAccount. This API exists to close a client . If the client have any active loans/savingsAccount this API will result in an error. Reject a Client: Clients can be rejected when client is in pending for activation status. If the client is any other status, this API throws an error. Mandatory Fields: rejectionDate, rejectionReasonId Withdraw a Client: Client applications can be withdrawn when client is in a pending for activation status. If the client is any other status, this API throws an error. Mandatory Fields: withdrawalDate, withdrawalReasonId Reactivate a Client: Clients can be reactivated after they have been closed. Trying to reactivate a client in any other state throws an error. Mandatory Fields: reactivationDate UndoReject a Client: Clients can be reactivated after they have been rejected. Trying to reactivate a client in any other state throws an error. Mandatory Fields: reopenedDateUndoWithdraw a Client: Clients can be reactivated after they have been withdrawn. Trying to reactivate a client in any other state throws an error. Mandatory Fields: reopenedDate Assign a Staff: Allows you to assign a Staff for existed Client. The selected Staff should belong to the same office (or an officer higher up in the hierarchy) as the Client he manages. Unassign a Staff: Allows you to unassign the Staff assigned to a Client. Update Default Savings Account: Allows you to modify or assign a default savings account for an existing Client. The selected savings account should be one among the existing savings account for a particular customer. Propose a Client Transfer: Allows you to propose the transfer of a Client to a different Office. Withdraw a Client Transfer: Allows you to withdraw the proposed transfer of a Client to a different Office. Withdrawal can happen only if the destination Branch (to which the transfer was proposed) has not already accepted the transfer proposal Reject a Client Transfer: Allows the Destination Branch to reject the proposed Client Transfer. Accept a Client Transfer: Allows the Destination Branch to accept the proposed Client Transfer. The destination branch may also choose to link this client to a group (in which case, any existing active JLG loan of the client is rescheduled to match the meeting frequency of the group) and loan Officer at the time of accepting the transfer Propose and Accept a Client Transfer: Abstraction over the Propose and Accept Client Transfer API’s which enable a user with Data Scope over both the Target and Destination Branches to directly transfer a Client to the destination Office. Showing request/response for 'Reject a Client Transfer'

Parameters
Path Parameters
Name Description Required Default Pattern

clientId

clientId

X

null

Body Parameter
Name Description Required Default Pattern

PostClientsClientIdRequest

Section .2.818

X

Query Parameters
Name Description Required Default Pattern

command

command

-

null

Return Type
Content Type
  • application/json

Responses
Table 68. http response codes
Code Message Datatype

200

OK

Section .2.819

Samples
create6

POST /clients

Create a Client

Description

Note: 1. You can enter either:firstname/middlename/lastname - for a person (middlename is optional) OR fullname - for a business or organisation (or person known by one name). 2.If address is enable(enable-address=true), then additional field called address has to be passed. Mandatory Fields: firstname and lastname OR fullname, officeId, active=true and activationDate OR active=false, if(address enabled) address Optional Fields: groupId, externalId, accountNo, staffId, mobileNo, savingsProductId, genderId, clientTypeId, clientClassificationId

Parameters
Body Parameter
Name Description Required Default Pattern

PostClientsRequest

Section .2.822

X

Return Type
Content Type
  • application/json

Responses
Table 69. http response codes
Code Message Datatype

200

OK

Section .2.823

Samples
delete9

DELETE /clients/{clientId}

Delete a Client

Description

If a client is in Pending state, you are allowed to Delete it. The delete is a 'hard delete' and cannot be recovered from. Once clients become active or have loans or savings associated with them, you cannot delete the client but you may Close the client if they have left the program.

Parameters
Path Parameters
Name Description Required Default Pattern

clientId

clientId

X

null

Body Parameter
Name Description Required Default Pattern

body

[object]

X

Return Type
Content Type
  • application/json

Responses
Table 70. http response codes
Code Message Datatype

200

OK

Section .2.33

Samples
getClientTemplate

GET /clients/downloadtemplate

Description
Parameters
Query Parameters
Name Description Required Default Pattern

legalFormType

-

null

officeId

-

null

staffId

-

null

dateFormat

-

null

Return Type

-

Content Type
  • application/vnd.ms-excel

Responses
Table 71. http response codes
Code Message Datatype

0

default response

<<>>

Samples
postClientTemplate

POST /clients/uploadtemplate

Description
Parameters
Form Parameters
Name Description Required Default Pattern

dateFormat

[string]

-

null

locale

[string]

-

null

uploadedInputStream

[file]

-

null

Query Parameters
Name Description Required Default Pattern

legalFormType

-

null

Return Type
Content Type
  • /

Responses
Table 72. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveAll21

GET /clients

List Clients

Description

The list capability of clients can support pagination and sorting. Example Requests: clients clients?fields=displayName,officeName,timeline clients?offset=10&limit=50 clients?orderBy=displayName&sortOrder=DESC

Parameters
Query Parameters
Name Description Required Default Pattern

sqlSearch

sqlSearch

-

null

officeId

officeId

-

null

externalId

externalId

-

null

displayName

displayName

-

null

firstName

firstName

-

null

lastName

lastName

-

null

status

status

-

null

underHierarchy

underHierarchy

-

null

offset

offset

-

null

limit

limit

-

null

orderBy

orderBy

-

null

sortOrder

sortOrder

-

null

orphansOnly

orphansOnly

-

null

Return Type
Content Type
  • application/json

Responses
Table 73. http response codes
Code Message Datatype

200

OK

Section .2.206

Samples
retrieveAssociatedAccounts

GET /clients/{clientId}/accounts

Retrieve client accounts overview

Description

An example of how a loan portfolio summary can be provided. This is requested in a specific use case of the community application. It is quite reasonable to add resources like this to simplify User Interface development. Example Requests: clients/1/accounts clients/1/accounts?fields=loanAccounts,savingsAccounts

Parameters
Path Parameters
Name Description Required Default Pattern

clientId

clientId

X

null

Return Type
Content Type
  • application/json

Responses
Table 74. http response codes
Code Message Datatype

200

OK

Section .2.187

400

Bad Request

<<>>

Samples
retrieveObligeeDetails

GET /clients/{clientId}/obligeedetails

Description
Parameters
Path Parameters
Name Description Required Default Pattern

clientId

X

null

Return Type
Content Type
  • application/json

Responses
Table 75. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveOne11

GET /clients/{clientId}

Retrieve a Client

Description

Example Requests: clients/1 clients/1?template=true clients/1?fields=id,displayName,officeName

Parameters
Path Parameters
Name Description Required Default Pattern

clientId

clientId

X

null

Query Parameters
Name Description Required Default Pattern

staffInSelectedOfficeOnly

staffInSelectedOfficeOnly

-

false

Return Type
Content Type
  • application/json

Responses
Table 76. http response codes
Code Message Datatype

200

OK

Section .2.191

Samples
retrieveTemplate5

GET /clients/template

Retrieve Client Details Template

Description

This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults Allowed Value Lists Example Request: clients/template

Parameters
Query Parameters
Name Description Required Default Pattern

officeId

officeId

-

null

commandParam

commandParam

-

null

staffInSelectedOfficeOnly

staffInSelectedOfficeOnly

-

false

Return Type
Content Type
  • application/json

Responses
Table 77. http response codes
Code Message Datatype

200

OK

Section .2.213

Samples
retrieveTransferTemplate

GET /clients/{clientId}/transferproposaldate

Description
Parameters
Path Parameters
Name Description Required Default Pattern

clientId

X

null

Return Type
Content Type
  • application/json

Responses
Table 78. http response codes
Code Message Datatype

0

default response

[String]

Samples
update10

PUT /clients/{clientId}

Update a Client

Description

Note: You can update any of the basic attributes of a client (but not its associations) using this API. Changing the relationship between a client and its office is not supported through this API. An API specific to handling transfers of clients between offices is available for the same. The relationship between a client and a group must be removed through the Groups API.

Parameters
Path Parameters
Name Description Required Default Pattern

clientId

clientId

X

null

Body Parameter
Name Description Required Default Pattern

PutClientsClientIdRequest

Section .2.1012

X

Return Type
Content Type
  • application/json

Responses
Table 79. http response codes
Code Message Datatype

200

OK

Section .2.1013

Samples

.1.18. ClientCharges

applyClientCharge

POST /clients/{clientId}/charges

Add Client Charge

Description
This API associates a Client charge with an implicit Client account Mandatory Fields :  chargeId and dueDate   Optional Fields :  amount
Parameters
Path Parameters
Name Description Required Default Pattern

clientId

clientId

X

null

Body Parameter
Name Description Required Default Pattern

PostClientsClientIdChargesRequest

Section .2.814

X

Return Type
Content Type
  • application/json

Responses
Table 80. http response codes
Code Message Datatype

200

OK

Section .2.815

Samples
deleteClientCharge

DELETE /clients/{clientId}/charges/{chargeId}

Delete a Client Charge

Description

Deletes a Client Charge on which no transactions have taken place (either payments or waivers).

Parameters
Path Parameters
Name Description Required Default Pattern

clientId

clientId

X

null

chargeId

chargeId

X

null

Return Type
Content Type
  • application/json

Responses
Table 81. http response codes
Code Message Datatype

200

OK

Section .2.31

Samples
payOrWaiveClientCharge

POST /clients/{clientId}/charges/{chargeId}

Pay a Client Charge | Waive a Client Charge

Description

Pay a Client Charge: Mandatory Fields:transactionDate and amount \"Pay either a part of or the entire due amount for a charge.(command=paycharge) Waive a Client Charge: This API provides the facility of waiving off the remaining amount on a client charge (command=waive) Showing request/response for 'Pay a Client Charge'

Parameters
Path Parameters
Name Description Required Default Pattern

clientId

clientId

X

null

chargeId

chargeId

X

null

Body Parameter
Name Description Required Default Pattern

PostClientsClientIdChargesChargeIdRequest

Section .2.812

X

Query Parameters
Name Description Required Default Pattern

command

command

-

null

Return Type
Content Type
  • application/json

Responses
Table 82. http response codes
Code Message Datatype

200

OK

Section .2.813

Samples
retrieveAllClientCharges

GET /clients/{clientId}/charges

List Client Charges

Description

The list capability of client charges supports pagination.Example Requests: clients/1/charges clients/1/charges?offset=0&limit=5

Parameters
Path Parameters
Name Description Required Default Pattern

clientId

clientId

X

null

Query Parameters
Name Description Required Default Pattern

chargeStatus

chargeStatus

-

all

pendingPayment

pendingPayment

-

null

limit

limit

-

null

offset

offset

-

null

Return Type
Content Type
  • application/json

Responses
Table 83. http response codes
Code Message Datatype

200

OK

Section .2.188

Samples
retrieveClientCharge

GET /clients/{clientId}/charges/{chargeId}

Retrieve a Client Charge

Description

Example Requests: clients/1/charges/1 clients/1/charges/1?fields=name,id

Parameters
Path Parameters
Name Description Required Default Pattern

clientId

clientId

X

null

chargeId

chargeId

X

null

Return Type
Content Type
  • application/json

Responses
Table 84. http response codes
Code Message Datatype

200

OK

Section .2.186

Samples
retrieveTemplate4

GET /clients/{clientId}/charges/template

Description
Parameters
Path Parameters
Name Description Required Default Pattern

clientId

clientId

X

null

Return Type
Content Type
  • application/json

Responses
Table 85. http response codes
Code Message Datatype

0

default response

[String]

Samples

.1.19. ClientCollateralManagement

addCollateral

POST /clients/{clientId}/collaterals

Add New Collateral For a Client

Description

Add New Collateral For a Client

Parameters
Path Parameters
Name Description Required Default Pattern

clientId

clientId

X

null

Body Parameter
Name Description Required Default Pattern

PostClientCollateralRequest

Section .2.809

X

Return Type
Content Type
  • application/json

Responses
Table 86. http response codes
Code Message Datatype

200

OK

Section .2.810

Samples
deleteCollateral1

DELETE /clients/{clientId}/collaterals/{collateralId}

Delete Client Collateral

Description

Delete Client Collateral

Parameters
Path Parameters
Name Description Required Default Pattern

clientId

clientId

X

null

collateralId

collateralId

X

null

Return Type
Content Type
  • application/json

Responses
Table 87. http response codes
Code Message Datatype

200

OK

Section .2.30

Samples
getClientCollateral

GET /clients/{clientId}/collaterals

Get Clients Collateral Products

Description

Get Collateral Product of a Client

Parameters
Path Parameters
Name Description Required Default Pattern

clientId

clientId

X

null

Query Parameters
Name Description Required Default Pattern

prodId

prodId

-

null

Return Type
Content Type
  • application/json

Responses
Table 88. http response codes
Code Message Datatype

200

OK

List[[object]]

Samples
getClientCollateralData

GET /clients/{clientId}/collaterals/{clientCollateralId}

Get Client Collateral Data

Description

Get Client Collateral Data

Parameters
Path Parameters
Name Description Required Default Pattern

clientId

clientId

X

null

clientCollateralId

clientCollateralId

X

null

Return Type
Content Type
  • application/json

Responses
Table 89. http response codes
Code Message Datatype

200

OK

[Object]

Samples
getClientCollateralTemplate

GET /clients/{clientId}/collaterals/template

Get Client Collateral Template

Description

Get Client Collateral Template

Parameters
Path Parameters
Name Description Required Default Pattern

clientId

clientId

X

null

Return Type
Content Type
  • application/json

Responses
Table 90. http response codes
Code Message Datatype

200

OK

List[Section .2.352]

Samples
updateCollateral1

PUT /clients/{clientId}/collaterals/{collateralId}

Update New Collateral of a Client

Description

Update New Collateral of a Client

Parameters
Path Parameters
Name Description Required Default Pattern

clientId

clientId

X

null

collateralId

collateralId

X

null

Body Parameter
Name Description Required Default Pattern

PutClientCollateralRequest

Section .2.1008

X

Return Type
Content Type
  • application/json

Responses
Table 91. http response codes
Code Message Datatype

200

OK

Section .2.1009

Samples

.1.20. ClientFamilyMember

addClientFamilyMembers

POST /clients/{clientId}/familymembers

Description
Parameters
Path Parameters
Name Description Required Default Pattern

clientId

X

null

Body Parameter
Name Description Required Default Pattern

body

[string]

-

Return Type
Content Type
  • application/json

Responses
Table 92. http response codes
Code Message Datatype

0

default response

[String]

Samples
deleteClientFamilyMembers

DELETE /clients/{clientId}/familymembers/{familyMemberId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

familyMemberId

X

null

clientId

clientId

X

null

Body Parameter
Name Description Required Default Pattern

body

[string]

-

Return Type
Content Type
  • application/json

Responses
Table 93. http response codes
Code Message Datatype

0

default response

[String]

Samples
getFamilyMember

GET /clients/{clientId}/familymembers/{familyMemberId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

familyMemberId

X

null

clientId

clientId

X

null

Return Type
Content Type
  • application/json

Responses
Table 94. http response codes
Code Message Datatype

0

default response

[String]

Samples
getFamilyMembers

GET /clients/{clientId}/familymembers

Description
Parameters
Path Parameters
Name Description Required Default Pattern

clientId

X

null

Return Type
Content Type
  • application/json

Responses
Table 95. http response codes
Code Message Datatype

0

default response

[String]

Samples
getTemplate2

GET /clients/{clientId}/familymembers/template

Description
Parameters
Path Parameters
Name Description Required Default Pattern

clientId

X

null

Return Type
Content Type
  • application/json

Responses
Table 96. http response codes
Code Message Datatype

0

default response

[String]

Samples
updateClientFamilyMembers

PUT /clients/{clientId}/familymembers/{familyMemberId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

familyMemberId

X

null

clientId

clientId

X

null

Body Parameter
Name Description Required Default Pattern

body

[string]

-

Return Type
Content Type
  • application/json

Responses
Table 97. http response codes
Code Message Datatype

0

default response

[String]

Samples

.1.21. ClientIdentifier

createClientIdentifier

POST /clients/{clientId}/identifiers

Create an Identifier for a Client

Description

Mandatory Fields documentKey, documentTypeId

Parameters
Path Parameters
Name Description Required Default Pattern

clientId

clientId

X

null

Body Parameter
Name Description Required Default Pattern

PostClientsClientIdIdentifiersRequest

Section .2.816

X

Return Type
Content Type
  • application/json

Responses
Table 98. http response codes
Code Message Datatype

200

OK

Section .2.817

Samples
deleteClientIdentifier

DELETE /clients/{clientId}/identifiers/{identifierId}

Delete a Client Identifier

Description

Deletes a Client Identifier

Parameters
Path Parameters
Name Description Required Default Pattern

clientId

clientId

X

null

identifierId

identifierId

X

null

Return Type
Content Type
  • application/json

Responses
Table 99. http response codes
Code Message Datatype

200

OK

Section .2.32

Samples
newClientIdentifierDetails

GET /clients/{clientId}/identifiers/template

Retrieve Client Identifier Details Template

Description

This is a convenience resource useful for building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults Allowed description Lists Example Request: clients/1/identifiers/template

Parameters
Path Parameters
Name Description Required Default Pattern

clientId

clientId

X

null

Return Type
Content Type
  • application/json

Responses
Table 100. http response codes
Code Message Datatype

200

OK

Section .2.190

Samples
retrieveAllClientIdentifiers

GET /clients/{clientId}/identifiers

List all Identifiers for a Client

Description

Example Requests: clients/1/identifiers clients/1/identifiers?fields=documentKey,documentType,description

Parameters
Path Parameters
Name Description Required Default Pattern

clientId

clientId

X

null

Return Type
Content Type
  • application/json

Responses
Table 101. http response codes
Code Message Datatype

200

OK

List[Section .2.189]

Samples
retrieveClientIdentifiers

GET /clients/{clientId}/identifiers/{identifierId}

Retrieve a Client Identifier

Description

Example Requests: clients/1/identifier/2 clients/1/identifier/2?template=true clients/1/identifiers/2?fields=documentKey,documentType,description

Parameters
Path Parameters
Name Description Required Default Pattern

clientId

clientId

X

null

identifierId

identifierId

X

null

Return Type
Content Type
  • application/json

Responses
Table 102. http response codes
Code Message Datatype

200

OK

Section .2.189

Samples
updateClientIdentifer

PUT /clients/{clientId}/identifiers/{identifierId}

Update a Client Identifier

Description

Updates a Client Identifier

Parameters
Path Parameters
Name Description Required Default Pattern

clientId

clientId

X

null

identifierId

identifierId

X

null

Body Parameter
Name Description Required Default Pattern

PutClientsClientIdIdentifiersIdentifierIdRequest

Section .2.1010

X

Return Type
Content Type
  • application/json

Responses
Table 103. http response codes
Code Message Datatype

200

OK

Section .2.1011

Samples

.1.22. ClientTransaction

retrieveAllClientTransactions

GET /clients/{clientId}/transactions

List Client Transactions

Description

The list capability of client transaction can support pagination. Example Requests: clients/189/transactions clients/189/transactions?offset=10&limit=50

Parameters
Path Parameters
Name Description Required Default Pattern

clientId

clientId

X

null

Query Parameters
Name Description Required Default Pattern

offset

offset

-

null

limit

limit

-

null

Return Type
Content Type
  • application/json

Responses
Table 104. http response codes
Code Message Datatype

200

OK

Section .2.193

Samples
retrieveClientTransaction

GET /clients/{clientId}/transactions/{transactionId}

Retrieve a Client Transaction

Description

Example Requests: clients/1/transactions/1 clients/1/transactions/1?fields=id,officeName

Parameters
Path Parameters
Name Description Required Default Pattern

clientId

clientId

X

null

transactionId

transactionId

X

null

Return Type
Content Type
  • application/json

Responses
Table 105. http response codes
Code Message Datatype

200

OK

Section .2.194

Samples
undoClientTransaction

POST /clients/{clientId}/transactions/{transactionId}

Undo a Client Transaction

Description

Undoes a Client Transaction

Parameters
Path Parameters
Name Description Required Default Pattern

clientId

clientId

X

null

transactionId

transactionId

X

null

Query Parameters
Name Description Required Default Pattern

command

command

-

null

Return Type
Content Type
  • application/json

Responses
Table 106. http response codes
Code Message Datatype

200

OK

Section .2.820

Samples

.1.23. ClientsAddress

addClientAddress

POST /client/{clientid}/addresses

Create an address for a Client

Description

Mandatory Fields : type and clientId

Parameters
Path Parameters
Name Description Required Default Pattern

clientid

clientId

X

null

Body Parameter
Name Description Required Default Pattern

PostClientClientIdAddressesRequest

Section .2.807

X

Query Parameters
Name Description Required Default Pattern

type

type

-

null

Return Type
Content Type
  • application/json

Responses
Table 107. http response codes
Code Message Datatype

200

OK

Section .2.808

Samples
getAddresses1

GET /client/{clientid}/addresses

List all addresses for a Client

Description

Example Requests: client/1/addresses clients/1/addresses?status=false,true&&type=1,2,3

Parameters
Path Parameters
Name Description Required Default Pattern

clientid

clientId

X

null

Query Parameters
Name Description Required Default Pattern

status

status

-

null

type

type

-

null

Return Type
Content Type
  • application/json

Responses
Table 108. http response codes
Code Message Datatype

200

OK

List[Section .2.177]

Samples
getAddressesTemplate

GET /client/addresses/template

Description
Parameters
Return Type
Content Type
  • application/json

Responses
Table 109. http response codes
Code Message Datatype

0

default response

[String]

Samples
updateClientAddress

PUT /client/{clientid}/addresses

Update an address for a Client

Description

All the address fields can be updated by using update client address API Mandatory Fields type and addressId

Parameters
Path Parameters
Name Description Required Default Pattern

clientid

clientId

X

null

Body Parameter
Name Description Required Default Pattern

PutClientClientIdAddressesRequest

Section .2.1006

X

Return Type
Content Type
  • application/json

Responses
Table 110. http response codes
Code Message Datatype

200

OK

Section .2.1007

Samples

.1.24. CodeValues

createCodeValue

POST /codes/{codeId}/codevalues

Create a Code description

Description
Parameters
Path Parameters
Name Description Required Default Pattern

codeId

codeId

X

null

Body Parameter
Name Description Required Default Pattern

PostCodeValuesDataRequest

Section .2.825

X

Return Type
Content Type
  • application/json

Responses
Table 111. http response codes
Code Message Datatype

200

OK

Section .2.824

Samples
deleteCodeValue

DELETE /codes/{codeId}/codevalues/{codeValueId}

Delete a Code description

Description

Deletes a code description

Parameters
Path Parameters
Name Description Required Default Pattern

codeId

codeId

X

null

codeValueId

codeValueId

X

null

Return Type
Content Type
  • application/json

Responses
Table 112. http response codes
Code Message Datatype

200

OK

Section .2.34

Samples
retrieveAllCodeValues

GET /codes/{codeId}/codevalues

List Code Values

Description

Returns the list of Code Values for a given Code Example Requests: codes/1/codevalues

Parameters
Path Parameters
Name Description Required Default Pattern

codeId

codeId

X

null

Return Type
Content Type
  • application/json

Responses
Table 113. http response codes
Code Message Datatype

200

A List of code values for a given code

List[Section .2.215]

Samples
retrieveCodeValue

GET /codes/{codeId}/codevalues/{codeValueId}

Retrieve a Code description

Description

Returns the details of a Code Value Example Requests: codes/1/codevalues/1

Parameters
Path Parameters
Name Description Required Default Pattern

codeValueId

codeValueId

X

null

codeId

codeId

X

null

Return Type
Content Type
  • application/json

Responses
Table 114. http response codes
Code Message Datatype

200

OK

Section .2.215

Samples
updateCodeValue

PUT /codes/{codeId}/codevalues/{codeValueId}

Update a Code description

Description

Updates the details of a code description.

Parameters
Path Parameters
Name Description Required Default Pattern

codeId

codeId

X

null

codeValueId

codeValueId

X

null

Body Parameter
Name Description Required Default Pattern

PutCodeValuesDataRequest

Section .2.1016

X

Return Type
Content Type
  • application/json

Responses
Table 115. http response codes
Code Message Datatype

200

OK

Section .2.1014

Samples

.1.25. Codes

createCode

POST /codes

Create a Code

Description

Creates a code. Codes created through api are always 'user defined' and so system defined is marked as false.

Parameters
Body Parameter
Name Description Required Default Pattern

PostCodesRequest

Section .2.826

X

Return Type
Content Type
  • application/json

Responses
Table 116. http response codes
Code Message Datatype

200

OK

Section .2.827

Samples
deleteCode

DELETE /codes/{codeId}

Delete a Code

Description

Deletes a code if it is not system defined.

Parameters
Path Parameters
Name Description Required Default Pattern

codeId

codeId

X

null

Return Type
Content Type
  • application/json

Responses
Table 117. http response codes
Code Message Datatype

200

OK

Section .2.35

Samples
retrieveCode

GET /codes/{codeId}

Retrieve a Code

Description

Returns the details of a Code. Example Requests: codes/1

Parameters
Path Parameters
Name Description Required Default Pattern

codeId

codeId

X

null

Return Type
Content Type
  • application/json

Responses
Table 118. http response codes
Code Message Datatype

200

OK

Section .2.216

Samples
retrieveCodes

GET /codes

Retrieve Codes

Description

Returns the list of codes. Example Requests: codes

Parameters
Return Type
Content Type
  • application/json

Responses
Table 119. http response codes
Code Message Datatype

200

OK

List[Section .2.216]

Samples
updateCode

PUT /codes/{codeId}

Update a Code

Description

Updates the details of a code if it is not system defined.

Parameters
Path Parameters
Name Description Required Default Pattern

codeId

codeId

X

null

Body Parameter
Name Description Required Default Pattern

PutCodesRequest

Section .2.1018

X

Return Type
Content Type
  • application/json

Responses
Table 120. http response codes
Code Message Datatype

200

OK

Section .2.1019

Samples

.1.26. CollateralManagement

createCollateral1

POST /collateral-management

Create a new collateral

Description

Collateral Creation

Parameters
Body Parameter
Name Description Required Default Pattern

PostCollateralManagementProductRequest

Section .2.828

X

Return Type
Content Type
  • application/json

Responses
Table 121. http response codes
Code Message Datatype

200

OK

Section .2.829

Samples
deleteCollateral2

DELETE /collateral-management/{collateralId}

Delete a Collateral

Description

Delete Collateral

Parameters
Path Parameters
Name Description Required Default Pattern

collateralId

collateralId

X

null

Return Type
Content Type
  • application/json

Responses
Table 122. http response codes
Code Message Datatype

200

OK

Section .2.36

Samples
getAllCollaterals

GET /collateral-management

Get All Collaterals

Description

Fetch all Collateral Products

Parameters
Return Type
Content Type
  • application/json

Responses
Table 123. http response codes
Code Message Datatype

200

OK

List[Section .2.218]

Samples
getCollateral

GET /collateral-management/{collateralId}

Get Collateral

Description

Fetch Collateral

Parameters
Path Parameters
Name Description Required Default Pattern

collateralId

collateralId

X

null

Return Type
Content Type
  • application/json

Responses
Table 124. http response codes
Code Message Datatype

200

OK

Section .2.218

Samples
getCollateralTemplate

GET /collateral-management/template

Get Collateral Template

Description

Get Collateral Template

Parameters
Return Type
Content Type
  • application/json

Responses
Table 125. http response codes
Code Message Datatype

200

OK

List[Section .2.219]

Samples
updateCollateral2

PUT /collateral-management/{collateralId}

Update Collateral

Description

Update Collateral

Parameters
Path Parameters
Name Description Required Default Pattern

collateralId

collateralId

X

null

Body Parameter
Name Description Required Default Pattern

PutCollateralProductRequest

Section .2.1020

X

Return Type
Content Type
  • application/json

Responses
Table 126. http response codes
Code Message Datatype

200

OK

Section .2.1021

Samples

.1.27. CollectionSheet

generateCollectionSheet

POST /collectionsheet

Generate Individual Collection Sheet | Save Collection Sheet

Description

Generate Individual Collection Sheet: This Api retrieves repayment details of all individual loans under a office as on a specified meeting date. Save Collection Sheet: This Api allows the loan officer to perform bulk repayments of individual loans and deposit of mandatory savings on a given meeting date.

Parameters
Body Parameter
Name Description Required Default Pattern

PostCollectionSheetRequest

Section .2.832

X

Query Parameters
Name Description Required Default Pattern

command

command

-

null

Return Type
Content Type
  • application/json

Responses
Table 127. http response codes
Code Message Datatype

200

OK

Section .2.833

Samples

.1.28. CreditBureauConfiguration

addOrganisationCreditBureau

POST /CreditBureauConfiguration/organisationCreditBureau/{organisationCreditBureauId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

organisationCreditBureauId

X

null

Body Parameter
Name Description Required Default Pattern

body

[string]

-

Return Type
Content Type
  • application/json

Responses
Table 128. http response codes
Code Message Datatype

0

default response

[String]

Samples
createCreditBureauConfiguration

POST /CreditBureauConfiguration/configuration/{creditBureauId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

creditBureauId

X

null

Body Parameter
Name Description Required Default Pattern

body

[string]

-

Return Type
Content Type
  • application/json

Responses
Table 129. http response codes
Code Message Datatype

0

default response

[String]

Samples
createCreditBureauLoanProductMapping

POST /CreditBureauConfiguration/mappings/{organisationCreditBureauId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

organisationCreditBureauId

X

null

Body Parameter
Name Description Required Default Pattern

body

[string]

-

Return Type
Content Type
  • application/json

Responses
Table 130. http response codes
Code Message Datatype

0

default response

[String]

Samples
fetchLoanProducts

GET /CreditBureauConfiguration/loanProduct

Description
Parameters
Return Type
Content Type
  • application/json

Responses
Table 131. http response codes
Code Message Datatype

0

default response

[String]

Samples
fetchMappingByLoanProductId

GET /CreditBureauConfiguration/loanProduct/{loanProductId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

loanProductId

X

null

Return Type
Content Type
  • application/json

Responses
Table 132. http response codes
Code Message Datatype

0

default response

[String]

Samples
getConfiguration

GET /CreditBureauConfiguration/config/{organisationCreditBureauId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

organisationCreditBureauId

X

null

Return Type
Content Type
  • application/json

Responses
Table 133. http response codes
Code Message Datatype

0

default response

[String]

Samples
getCreditBureau

GET /CreditBureauConfiguration

Description
Parameters
Return Type
Content Type
  • application/json

Responses
Table 134. http response codes
Code Message Datatype

0

default response

[String]

Samples
getCreditBureauLoanProductMapping

GET /CreditBureauConfiguration/mappings

Description
Parameters
Return Type
Content Type
  • application/json

Responses
Table 135. http response codes
Code Message Datatype

0

default response

[String]

Samples
getOrganisationCreditBureau

GET /CreditBureauConfiguration/organisationCreditBureau

Description
Parameters
Return Type
Content Type
  • application/json

Responses
Table 136. http response codes
Code Message Datatype

0

default response

[String]

Samples
updateCreditBureau

PUT /CreditBureauConfiguration/organisationCreditBureau

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

[string]

-

Return Type
Content Type
  • application/json

Responses
Table 137. http response codes
Code Message Datatype

0

default response

[String]

Samples
updateCreditBureauConfiguration

PUT /CreditBureauConfiguration/configuration/{configurationId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

configurationId

X

null

Body Parameter
Name Description Required Default Pattern

body

[string]

-

Return Type
Content Type
  • application/json

Responses
Table 138. http response codes
Code Message Datatype

0

default response

[String]

Samples
updateCreditBureauLoanProductMapping

PUT /CreditBureauConfiguration/mappings

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

[string]

-

Return Type
Content Type
  • application/json

Responses
Table 139. http response codes
Code Message Datatype

0

default response

[String]

Samples

.1.29. Currency

retrieveCurrencies

GET /currencies

Retrieve Currency Configuration

Description

Returns the list of currencies permitted for use AND the list of currencies not selected (but available for selection). Example Requests: currencies currencies?fields=selectedCurrencyOptions

Parameters
Return Type
Content Type
  • application/json

Responses
Table 140. http response codes
Code Message Datatype

200

OK

Section .2.222

Samples
updateCurrencies

PUT /currencies

Update Currency Configuration

Description

Updates the list of currencies permitted for use.

Parameters
Body Parameter
Name Description Required Default Pattern

PutCurrenciesRequest

Section .2.1022

X

Return Type
Content Type
  • application/json

Responses
Table 141. http response codes
Code Message Datatype

200

OK

Section .2.1023

Samples

.1.30. DataTables

createDatatable

POST /datatables

Create Data Table

Description

Create a new data table and registers it with the Apache Fineract Core application table. Field Descriptions Mandatory - datatableName : The name of the Data Table. Mandatory - apptableName Application table name. Must be one of the following: m_client m_group m_loan m_office m_saving_account m_product_loan m_savings_product Mandatory - columns An array of columns in the new Data Table. Optional - multiRow Allows to create multiple entries in the Data Table. Optional, defaults to false. If this property is not provided Data Table will allow only one entry. Field Descriptions - columns Mandatory - name Name of the created column. Can contain only alphanumeric characters, underscores and spaces, but cannot start with a number. Cannot start or end with an underscore or space. Mandatory - type Column type. Must be one of the following: Boolean Date DateTime Decimal Dropdown Number String Text Mandatory [type = Dropdown] - code Used in Code description fields. Column name becomes: code_cd_name. Mandatory if using type Dropdown, otherwise an error is returned. Optional - mandatory Determines whether this column must have a value in every entry. Optional, defaults to false. Mandatory [type = String] - length Length of the text field. Mandatory if type String is used, otherwise an error is returned.

Parameters
Body Parameter
Name Description Required Default Pattern

PostDataTablesRequest

Section .2.836

X

Return Type
Content Type
  • application/json

Responses
Table 142. http response codes
Code Message Datatype

200

OK

Section .2.837

Samples
createDatatableEntry

POST /datatables/{datatable}/{apptableId}

Create Entry in Data Table

Description

Adds a row to the data table. Note that the default datatable UI functionality converts any field name containing spaces to underscores when using the API. This means the field name \"Business Description\" is considered the same as \"Business_Description\". So you shouldn’t have both \"versions\" in any data table.

Parameters
Path Parameters
Name Description Required Default Pattern

datatable

datatable

X

null

apptableId

apptableId

X

null

Body Parameter
Name Description Required Default Pattern

body

{ &quot;BusinessDescription&quot;: &quot;Livestock sales&quot;, &quot;Comment&quot;: &quot;First comment made&quot;, &quot;Education_cv&quot;: &quot;Primary&quot;, &quot;Gender_cd&quot;: 6, &quot;HighestRatePaid&quot;: 8.5, &quot;NextVisit&quot;: &quot;01 October 2012&quot;, &quot;YearsinBusiness&quot;: 5, &quot;dateFormat&quot;: &quot;dd MMMM yyyy&quot;, &quot;locale&quot;: &quot;en&quot; } [string]

X

Return Type
Content Type
  • application/json

Responses
Table 143. http response codes
Code Message Datatype

200

OK

Section .2.835

Samples
deleteDatatable

DELETE /datatables/{datatableName}

Delete Data Table

Description

Deletes a data table and deregisters it from the Apache Fineract Core application table.

Parameters
Path Parameters
Name Description Required Default Pattern

datatableName

datatableName

X

null

Return Type
Content Type
  • application/json

Responses
Table 144. http response codes
Code Message Datatype

200

OK

Section .2.39

Samples
deleteDatatableEntries

DELETE /datatables/{datatable}/{apptableId}

Delete Entry(s) in Data Table

Description

Deletes the entry (if it exists) for data tables that are one-to-one with the application table. Deletes the entries (if they exist) for data tables that are one-to-many with the application table.

Parameters
Path Parameters
Name Description Required Default Pattern

datatable

datatable

X

null

apptableId

apptableId

X

null

Return Type
Content Type
  • application/json

Responses
Table 145. http response codes
Code Message Datatype

200

OK

Section .2.38

Samples
deleteDatatableEntries1

DELETE /datatables/{datatable}/{apptableId}/{datatableId}

Delete Entry in Datatable (One to Many)

Description

Deletes the entry (if it exists) for data tables that are one to many with the application table.

Parameters
Path Parameters
Name Description Required Default Pattern

datatable

datatable

X

null

apptableId

apptableId

X

null

datatableId

datatableId

X

null

Return Type
Content Type
  • application/json

Responses
Table 146. http response codes
Code Message Datatype

200

OK

Section .2.37

Samples
deregisterDatatable

POST /datatables/deregister/{datatable}

Deregister Data Table

Description

Deregisters a data table. It will no longer be available through the API.

Parameters
Path Parameters
Name Description Required Default Pattern

datatable

datatable

X

null

Return Type
Content Type
  • application/json

Responses
Table 147. http response codes
Code Message Datatype

200

OK

Section .2.1033

Samples
getDatatable

GET /datatables/{datatable}

Retrieve Data Table Details

Description

Lists a registered data table details and the Apache Fineract Core application table they are registered to.

Parameters
Path Parameters
Name Description Required Default Pattern

datatable

datatable

X

null

Return Type
Content Type
  • application/json

Responses
Table 148. http response codes
Code Message Datatype

200

OK

Section .2.224

Samples
getDatatable1

GET /datatables/{datatable}/{apptableId}

Retrieve Entry(s) from Data Table

Description

Gets the entry (if it exists) for data tables that are one to one with the application table. Gets the entries (if they exist) for data tables that are one to many with the application table. Note: The 'fields' parameter is not available for datatables. ARGUMENTS orderoptional Specifies the order in which data is returned.genericResultSetoptional, defaults to false If 'true' an optimised JSON format is returned suitable for tabular display of data. This format is used by the default data tables UI functionality. Example Requests: datatables/extra_client_details/1 datatables/extra_family_details/1?order=Date of Birth desc datatables/extra_client_details/1?genericResultSet=true

Parameters
Path Parameters
Name Description Required Default Pattern

datatable

datatable

X

null

apptableId

apptableId

X

null

Query Parameters
Name Description Required Default Pattern

order

order

-

null

Return Type
Content Type
  • application/json

Responses
Table 149. http response codes
Code Message Datatype

200

OK

[String]

Samples
getDatatableManyEntry

GET /datatables/{datatable}/{apptableId}/{datatableId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

datatable

X

null

apptableId

X

null

datatableId

X

null

Query Parameters
Name Description Required Default Pattern

order

-

null

Return Type
Content Type
  • application/json

Responses
Table 150. http response codes
Code Message Datatype

0

default response

[String]

Samples
getDatatables

GET /datatables

List Data Tables

Description

Lists registered data tables and the Apache Fineract Core application table they are registered to. ARGUMENTS apptable - optional The Apache Fineract core application table. Example Requests: datatables?apptable=m_client datatables

Parameters
Query Parameters
Name Description Required Default Pattern

apptable

apptable

-

null

Return Type
Content Type
  • application/json

Responses
Table 151. http response codes
Code Message Datatype

200

OK

List[Section .2.224]

Samples
registerDatatable

POST /datatables/register/{datatable}/{apptable}

Register Data Table

Description

Registers a data table with the Apache Fineract Core application table. This allows the data table to be maintained through the API. In case the datatable is a PPI (survey table), a parameter category should be pass along with the request. The API currently support one category (200)

Parameters
Path Parameters
Name Description Required Default Pattern

datatable

datatable

X

null

apptable

apptable

X

null

Body Parameter
Name Description Required Default Pattern

body

[object]

-

Return Type
Content Type
  • application/json

Responses
Table 152. http response codes
Code Message Datatype

200

OK

Section .2.1033

Samples
updateDatatable

PUT /datatables/{datatableName}

Update Data Table

Description

Modifies fields of a data table. If the apptableName parameter is passed, data table is deregistered and registered with the new application table.

Parameters
Path Parameters
Name Description Required Default Pattern

datatableName

datatableName

X

null

Body Parameter
Name Description Required Default Pattern

PutDataTablesRequest

Section .2.1029

X

Return Type
Content Type
  • application/json

Responses
Table 153. http response codes
Code Message Datatype

200

OK

Section .2.1033

Samples
updateDatatableEntryOneToMany

PUT /datatables/{datatable}/{apptableId}/{datatableId}

Update Entry in Data Table (One to Many)

Description

Updates the row (if it exists) of the data table.

Parameters
Path Parameters
Name Description Required Default Pattern

datatable

datatable

X

null

apptableId

apptableId

X

null

datatableId

datatableId

X

null

Body Parameter
Name Description Required Default Pattern

PutDataTablesAppTableIdDatatableIdRequest

Section .2.1024

X

Return Type
Content Type
  • application/json

Responses
Table 154. http response codes
Code Message Datatype

200

OK

Section .2.1025

Samples
updateDatatableEntryOnetoOne

PUT /datatables/{datatable}/{apptableId}

Update Entry in Data Table (One to One)

Description

Updates the row (if it exists) of the data table.

Parameters
Path Parameters
Name Description Required Default Pattern

datatable

datatable

X

null

apptableId

apptableId

X

null

Body Parameter
Name Description Required Default Pattern

PutDataTablesAppTableIdRequest

Section .2.1026

X

Return Type
Content Type
  • application/json

Responses
Table 155. http response codes
Code Message Datatype

200

OK

Section .2.1027

Samples

.1.31. Default

activate

POST /email/campaign/{resourceId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

resourceId

X

null

Body Parameter
Name Description Required Default Pattern

body

[string]

-

Query Parameters
Name Description Required Default Pattern

command

-

null

Return Type
Content Type
  • application/json

Responses
Table 156. http response codes
Code Message Datatype

0

default response

[String]

Samples
addCreditReport

POST /creditBureauIntegration/addCreditReport

Description
Parameters
Form Parameters
Name Description Required Default Pattern

dateFormat

[string]

-

null

locale

[string]

-

null

uploadedInputStream

[file]

-

null

Query Parameters
Name Description Required Default Pattern

creditBureauId

creditBureauId

-

null

Return Type
Content Type
  • /

Responses
Table 157. http response codes
Code Message Datatype

0

default response

[String]

Samples
addNewClientImage1

POST /{entity}/{entityId}/images

Description
Parameters
Path Parameters
Name Description Required Default Pattern

entity

X

null

entityId

X

null

Form Parameters
Name Description Required Default Pattern

dateFormat

[string]

-

null

locale

[string]

-

null

uploadedInputStream

[file]

-

null

Header Parameters
Name Description Required Default Pattern

Content-Length

-

null

Return Type
Content Type
  • application/json

Responses
Table 158. http response codes
Code Message Datatype

0

default response

[String]

Samples
create1

POST /email

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

[string]

-

Return Type
Content Type
  • application/json

Responses
Table 159. http response codes
Code Message Datatype

0

default response

[String]

Samples
createCampaign

POST /email/campaign

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

[string]

-

Return Type
Content Type
  • application/json

Responses
Table 160. http response codes
Code Message Datatype

0

default response

[String]

Samples
createCampaign1

POST /smscampaigns

Create a SMS Campaign

Description

Mandatory Fields campaignName, campaignType, triggerType, providerId, runReportId, message Mandatory Fields for Cash based on selected report id paramValue in json format

Parameters
Body Parameter
Name Description Required Default Pattern

CommandWrapper

Section .2.20

X

Return Type
Content Type
  • application/json

Responses
Table 161. http response codes
Code Message Datatype

200

OK

Section .2.19

Samples
delete1

DELETE /email/{resourceId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

resourceId

X

null

Return Type
Content Type
  • application/json

Responses
Table 162. http response codes
Code Message Datatype

0

default response

[String]

Samples
delete2

DELETE /email/campaign/{resourceId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

resourceId

X

null

Return Type
Content Type
  • application/json

Responses
Table 163. http response codes
Code Message Datatype

0

default response

[String]

Samples
delete3

DELETE /smscampaigns/{campaignId}

Delete a SMS Campaign

Description

Note: Only closed SMS Campaigns can be deleted

Parameters
Path Parameters
Name Description Required Default Pattern

campaignId

X

null

Return Type
Content Type
  • /

Responses
Table 164. http response codes
Code Message Datatype

200

OK

Section .2.19

Samples
delete8

DELETE /officetransactions/{transactionId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

transactionId

X

null

Return Type
Content Type
  • application/json

Responses
Table 165. http response codes
Code Message Datatype

0

default response

[String]

Samples
deleteClientImage

DELETE /{entity}/{entityId}/images

Description
Parameters
Path Parameters
Name Description Required Default Pattern

entity

X

null

entityId

X

null

Return Type
Content Type
  • application/json

Responses
Table 166. http response codes
Code Message Datatype

0

default response

[String]

Samples
deleteCreditReport

DELETE /creditBureauIntegration/deleteCreditReport/{creditBureauId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

creditBureauId

creditBureauId

X

null

Return Type
Content Type
  • application/json

Responses
Table 167. http response codes
Code Message Datatype

0

default response

[String]

Samples
fetchCreditReport

POST /creditBureauIntegration/creditReport

Description
Parameters
Body Parameter
Name Description Required Default Pattern

request_body

[object]

-

Return Type
Content Type
  • application/json

Responses
Table 168. http response codes
Code Message Datatype

0

default response

[String]

Samples
get

GET /echo

Description
Parameters
Return Type
Content Type
  • text/plain

Responses
Table 169. http response codes
Code Message Datatype

0

default response

[String]

Samples
getExternalGrammar

GET /application.wadl/{path}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

path

X

null

Return Type

-

Content Type
  • application/xml

Responses
Table 170. http response codes
Code Message Datatype

0

default response

<<>>

Samples
getSavedCreditReport

GET /creditBureauIntegration/creditReport/{creditBureauId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

creditBureauId

creditBureauId

X

null

Return Type
Content Type
  • application/json

Responses
Table 171. http response codes
Code Message Datatype

0

default response

[String]

Samples
getWadl

GET /application.wadl

Description
Parameters
Return Type

-

Content Type
  • application/vnd.sun.wadl+xml

  • application/xml

Responses
Table 172. http response codes
Code Message Datatype

0

default response

<<>>

Samples
handleCommands

POST /smscampaigns/{campaignId}

SMS Campaign

Description

Activates | Deactivates | Reactivates

Parameters
Path Parameters
Name Description Required Default Pattern

campaignId

X

null

Query Parameters
Name Description Required Default Pattern

command

-

null

Return Type
Content Type
  • application/json

Responses
Table 173. http response codes
Code Message Datatype

200

OK

Section .2.19

Samples
newOfficeTransactionDetails

GET /officetransactions/template

Description
Parameters
Return Type
Content Type
  • application/json

Responses
Table 174. http response codes
Code Message Datatype

0

default response

[String]

Samples
preview

POST /email/campaign/preview

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

[string]

-

Return Type
Content Type
  • application/json

Responses
Table 175. http response codes
Code Message Datatype

0

default response

[String]

Samples
preview1

POST /smscampaigns/preview

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

[string]

-

Return Type
Content Type
  • application/json

Responses
Table 176. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveAll5

GET /email/configuration

Description
Parameters
Return Type
Content Type
  • application/json

Responses
Table 177. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveAll9

GET /twofactor/configure

Description
Parameters
Return Type
Content Type
  • application/json

Responses
Table 178. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveAllCampaign

GET /email/campaign

Description
Parameters
Return Type
Content Type
  • application/json

Responses
Table 179. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveAllEmailByStatus

GET /email/messageByStatus

Description
Parameters
Query Parameters
Name Description Required Default Pattern

sqlSearch

-

null

offset

-

null

limit

-

null

status

-

null

orderBy

-

null

sortOrder

-

null

fromDate

-

null

toDate

-

null

locale

-

null

dateFormat

-

null

Return Type
Content Type
  • application/json

Responses
Table 180. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveAllEmails

GET /email

Description
Parameters
Return Type
Content Type
  • application/json

Responses
Table 181. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveAllEmails1

GET /smscampaigns

List SMS Campaigns

Description

Example Requests: smscampaigns

Parameters
Query Parameters
Name Description Required Default Pattern

sqlSearch

-

null

offset

-

null

limit

-

null

orderBy

-

null

sortOrder

-

null

Return Type
Content Type
  • application/json

Responses
Table 182. http response codes
Code Message Datatype

200

OK

Section .2.1175

Samples
retrieveCampaign

GET /smscampaigns/{resourceId}

Retrieve a SMS Campaign

Description

Example Requests: smscampaigns/1

Parameters
Path Parameters
Name Description Required Default Pattern

resourceId

X

null

Return Type
Content Type
  • application/json

Responses
Table 183. http response codes
Code Message Datatype

200

OK

Section .2.1175

Samples
retrieveFailedEmail

GET /email/failedEmail

Description
Parameters
Query Parameters
Name Description Required Default Pattern

sqlSearch

-

null

offset

-

null

limit

-

null

orderBy

-

null

sortOrder

-

null

Return Type
Content Type
  • application/json

Responses
Table 184. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveImage

GET /{entity}/{entityId}/images

Description
Parameters
Path Parameters
Name Description Required Default Pattern

entity

X

null

entityId

X

null

Header Parameters
Name Description Required Default Pattern

Accept

-

null

Query Parameters
Name Description Required Default Pattern

maxWidth

-

null

maxHeight

-

null

output

-

null

Return Type

-

Content Type
  • /

Responses
Table 185. http response codes
Code Message Datatype

0

default response

<<>>

Samples
retrieveOfficeTransactions

GET /officetransactions

Description
Parameters
Return Type
Content Type
  • application/json

Responses
Table 186. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveOne1

GET /email/{resourceId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

resourceId

X

null

Return Type
Content Type
  • application/json

Responses
Table 187. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveOneCampaign

GET /email/campaign/{resourceId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

resourceId

X

null

Return Type
Content Type
  • application/json

Responses
Table 188. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveOneTemplate

GET /email/campaign/template/{resourceId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

resourceId

X

null

Return Type
Content Type
  • application/json

Responses
Table 189. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrievePendingEmail

GET /email/pendingEmail

Description
Parameters
Query Parameters
Name Description Required Default Pattern

sqlSearch

-

null

offset

-

null

limit

-

null

orderBy

-

null

sortOrder

-

null

Return Type
Content Type
  • application/json

Responses
Table 190. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveSentEmail

GET /email/sentEmail

Description
Parameters
Query Parameters
Name Description Required Default Pattern

sqlSearch

-

null

offset

-

null

limit

-

null

orderBy

-

null

sortOrder

-

null

Return Type
Content Type
  • application/json

Responses
Table 191. http response codes
Code Message Datatype

0

default response

[String]

Samples
saveCreditReport

POST /creditBureauIntegration/saveCreditReport

Description
Parameters
Query Parameters
Name Description Required Default Pattern

creditBureauId

creditBureauId

-

null

nationalId

nationalId

-

null

Return Type
Content Type
  • application/json

Responses
Table 192. http response codes
Code Message Datatype

0

default response

[String]

Samples
template1

GET /email/campaign/template

Description
Parameters
Return Type
Content Type
  • application/json

Responses
Table 193. http response codes
Code Message Datatype

0

default response

[String]

Samples
template2

GET /smscampaigns/template

Retrieve a SMS Campaign

Description

Example Requests: smscampaigns/1 smscampaigns/1?template=true smscampaigns/template

Parameters
Return Type
Content Type
  • /

Responses
Table 194. http response codes
Code Message Datatype

200

OK

Section .2.1175

Samples
transferMoneyFrom

POST /officetransactions

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

[string]

-

Return Type
Content Type
  • application/json

Responses
Table 195. http response codes
Code Message Datatype

0

default response

[String]

Samples
update2

PUT /email/{resourceId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

resourceId

X

null

Body Parameter
Name Description Required Default Pattern

body

[string]

-

Return Type
Content Type
  • application/json

Responses
Table 196. http response codes
Code Message Datatype

0

default response

[String]

Samples
updateCampaign

PUT /email/campaign/{resourceId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

resourceId

X

null

Body Parameter
Name Description Required Default Pattern

body

[string]

-

Return Type
Content Type
  • application/json

Responses
Table 197. http response codes
Code Message Datatype

0

default response

[String]

Samples
updateCampaign1

PUT /smscampaigns/{campaignId}

Update a Campaign

Description
Parameters
Path Parameters
Name Description Required Default Pattern

campaignId

X

null

Body Parameter
Name Description Required Default Pattern

CommandWrapper

Section .2.20

X

Return Type
Content Type
  • application/json

Responses
Table 198. http response codes
Code Message Datatype

200

OK

Section .2.19

Samples
updateClientImage1

PUT /{entity}/{entityId}/images

Description
Parameters
Path Parameters
Name Description Required Default Pattern

entity

X

null

entityId

X

null

Form Parameters
Name Description Required Default Pattern

dateFormat

[string]

-

null

locale

[string]

-

null

uploadedInputStream

[file]

-

null

Header Parameters
Name Description Required Default Pattern

Content-Length

-

null

Return Type
Content Type
  • application/json

Responses
Table 199. http response codes
Code Message Datatype

0

default response

[String]

Samples
updateConfiguration

PUT /email/configuration

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

[string]

-

Return Type
Content Type
  • application/json

Responses
Table 200. http response codes
Code Message Datatype

0

default response

[String]

Samples
updateConfiguration3

PUT /twofactor/configure

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

[string]

-

Return Type
Content Type
  • application/json

Responses
Table 201. http response codes
Code Message Datatype

0

default response

[String]

Samples

.1.32. DepositAccountOnHoldFundTransactions

retrieveAll28

GET /savingsaccounts/{savingsId}/onholdtransactions

Description
Parameters
Path Parameters
Name Description Required Default Pattern

savingsId

X

null

Query Parameters
Name Description Required Default Pattern

guarantorFundingId

-

null

offset

-

null

limit

-

null

orderBy

-

null

sortOrder

-

null

Return Type
Content Type
  • application/json

Responses
Table 202. http response codes
Code Message Datatype

0

default response

[String]

Samples

.1.33. DeviceRegistration

delete5

DELETE /self/device/registration/{id}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Return Type
Content Type
  • application/json

Responses
Table 203. http response codes
Code Message Datatype

0

default response

[String]

Samples
registerDevice

POST /self/device/registration

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

[string]

-

Return Type
Content Type
  • application/json

Responses
Table 204. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveAllDeviceRegistrations

GET /self/device/registration

Description
Parameters
Return Type
Content Type
  • application/json

Responses
Table 205. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveDeviceRegiistration

GET /self/device/registration/{id}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Return Type
Content Type
  • application/json

Responses
Table 206. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveDeviceRegistrationByClientId

GET /self/device/registration/client/{clientId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

clientId

X

null

Return Type
Content Type
  • application/json

Responses
Table 207. http response codes
Code Message Datatype

0

default response

[String]

Samples
updateDeviceRegistration

PUT /self/device/registration/{id}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Body Parameter
Name Description Required Default Pattern

body

[string]

-

Return Type
Content Type
  • application/json

Responses
Table 208. http response codes
Code Message Datatype

0

default response

[String]

Samples

.1.34. Documents

createDocument

POST /{entityType}/{entityId}/documents

Create a Document

Description

Note: A document is created using a Multi-part form upload Body Parts name : Name or summary of the document description : Description of the document file : The file to be uploaded Mandatory Fields : file and description

Parameters
Path Parameters
Name Description Required Default Pattern

entityType

entityType

X

null

entityId

entityId

X

null

Form Parameters
Name Description Required Default Pattern

dateFormat

[string]

-

null

description

[string]

-

null

locale

[string]

-

null

name

[string]

-

null

uploadedInputStream

[file]

-

null

Header Parameters
Name Description Required Default Pattern

Content-Length

Content-Length

-

null

Return Type
Content Type
  • application/json

Responses
Table 209. http response codes
Code Message Datatype

200

Not Shown (multi-part form data)

Section .2.840

Samples
deleteDocument

DELETE /{entityType}/{entityId}/documents/{documentId}

Remove a Document

Description
Parameters
Path Parameters
Name Description Required Default Pattern

entityType

entityType

X

null

entityId

entityId

X

null

documentId

documentId

X

null

Return Type
Content Type
  • application/json

Responses
Table 210. http response codes
Code Message Datatype

200

OK

Section .2.41

Samples
downloadFile

GET /{entityType}/{entityId}/documents/{documentId}/attachment

Retrieve Binary File associated with Document

Description

Request used to download the file associated with the document Example Requests: clients/1/documents/1/attachment loans/1/documents/1/attachment

Parameters
Path Parameters
Name Description Required Default Pattern

entityType

entityType

X

null

entityId

entityId

X

null

documentId

documentId

X

null

Return Type

-

Responses
Table 211. http response codes
Code Message Datatype

200

Not Shown: The corresponding Binary file

<<>>

Samples
getDocument

GET /{entityType}/{entityId}/documents/{documentId}

Retrieve a Document

Description

Example Requests: clients/1/documents/1 loans/1/documents/1 client_identifiers/1/documents/1?fields=name,description

Parameters
Path Parameters
Name Description Required Default Pattern

entityType

entityType

X

null

entityId

entityId

X

null

documentId

documentId

X

null

Return Type
Content Type
  • application/json

Responses
Table 212. http response codes
Code Message Datatype

200

OK

Section .2.227

Samples
retrieveAllDocuments

GET /{entityType}/{entityId}/documents

List documents

Description

Example Requests: clients/1/documents client_identifiers/1/documents loans/1/documents?fields=name,description

Parameters
Path Parameters
Name Description Required Default Pattern

entityType

entityType

X

null

entityId

entityId

X

null

Return Type
Content Type
  • application/json

Responses
Table 213. http response codes
Code Message Datatype

200

OK

List[Section .2.227]

Samples
updateDocument

PUT /{entityType}/{entityId}/documents/{documentId}

Update a Document

Description

Note: A document is updated using a Multi-part form upload Body Parts name Name or summary of the document description Description of the document file The file to be uploaded

Parameters
Path Parameters
Name Description Required Default Pattern

entityType

entityType

X

null

entityId

entityId

X

null

documentId

documentId

X

null

Form Parameters
Name Description Required Default Pattern

dateFormat

[string]

-

null

description

[string]

-

null

locale

[string]

-

null

name

[string]

-

null

uploadedInputStream

[file]

-

null

Header Parameters
Name Description Required Default Pattern

Content-Length

Content-Length

-

null

Return Type
Content Type
  • application/json

Responses
Table 214. http response codes
Code Message Datatype

200

Not Shown (multi-part form data)

Section .2.1034

Samples

.1.35. EntityDataTable

createEntityDatatableCheck

POST /entityDatatableChecks

Create Entity-Datatable Checks

Description

Mandatory Fields : entity, status, datatableName Non-Mandatory Fields : productId

Parameters
Body Parameter
Name Description Required Default Pattern

PostEntityDatatableChecksTemplateRequest

Section .2.838

X

Return Type
Content Type
  • application/json

Responses
Table 215. http response codes
Code Message Datatype

200

OK

Section .2.839

Samples
deleteDatatable1

DELETE /entityDatatableChecks/{entityDatatableCheckId}

Delete Entity-Datatable Checks

Description

Deletes an existing Entity-Datatable Check

Parameters
Path Parameters
Name Description Required Default Pattern

entityDatatableCheckId

entityDatatableCheckId

X

null

Body Parameter
Name Description Required Default Pattern

body

[string]

-

Return Type
Content Type
  • application/json

Responses
Table 216. http response codes
Code Message Datatype

200

OK

Section .2.40

Samples
getTemplate

GET /entityDatatableChecks/template

Retrieve Entity-Datatable Checks Template

Description

This is a convenience resource useful for building maintenance user interface screens for Entity-Datatable Checks applications. The template data returned consists of: Allowed description Lists Example Request: entityDatatableChecks/template

Parameters
Return Type
Content Type
  • application/json

Responses
Table 217. http response codes
Code Message Datatype

200

OK

Section .2.226

Samples
retrieveAll6

GET /entityDatatableChecks

List Entity-Datatable Checks

Description

The list capability of Entity-Datatable Checks can support pagination. OPTIONAL ARGUMENTS offset Integer optional, defaults to 0 Indicates the result from which pagination startslimit Integer optional, defaults to 200 Restricts the size of results returned. To override the default and return all entries you must explicitly pass a non-positive integer value for limit e.g. limit=0, or limit=-1 Example Request: entityDatatableChecks?offset=0&limit=15

Parameters
Query Parameters
Name Description Required Default Pattern

status

status

-

null

entity

entity

-

null

productId

productId

-

null

offset

offset

-

null

limit

limit

-

null

Return Type
Content Type
  • application/json

Responses
Table 218. http response codes
Code Message Datatype

200

OK

List[Section .2.225]

Samples

.1.36. EntityFieldConfiguration

getAddresses

GET /fieldconfiguration/{entity}

Retrieves the Entity Field Configuration

Description

It retrieves all the Entity Field Configuration

Parameters
Path Parameters
Name Description Required Default Pattern

entity

entity

X

null

Return Type
Content Type
  • application/json

Responses
Table 219. http response codes
Code Message Datatype

200

OK

List[Section .2.229]

Samples

.1.37. ExternalServices

retrieveOne2

GET /externalservice/{servicename}

Retrieve External Services Configuration

Description

Returns a external Service configurations based on the Service Name. Service Names supported are S3 and SMTP. Example Requests: externalservice/SMTP

Parameters
Path Parameters
Name Description Required Default Pattern

servicename

servicename

X

null

Return Type
Content Type
  • application/json

Responses
Table 220. http response codes
Code Message Datatype

200

OK

Section .2.75

Samples
updateExternalServiceProperties

PUT /externalservice/{servicename}

Update External Service

Description

Updates the external Service Configuration for a Service Name. Example: externalservice/S3

Parameters
Path Parameters
Name Description Required Default Pattern

servicename

servicename

X

null

Body Parameter
Name Description Required Default Pattern

PutExternalServiceRequest

Section .2.1035

X

Return Type

-

Responses
Table 221. http response codes
Code Message Datatype

200

OK

<<>>

Samples

.1.38. FetchAuthenticatedUserDetails

fetchAuthenticatedUserData

GET /userdetails

Fetch authenticated user details

Description

checks the Authentication and returns the set roles and permissions allowed.

Parameters
Return Type
Content Type
  • application/json

Responses
Table 222. http response codes
Code Message Datatype

200

OK

Section .2.726

Samples

.1.39. FineractEntity

createMap

POST /entitytoentitymapping/{relId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

relId

X

null

Body Parameter
Name Description Required Default Pattern

body

[string]

-

Return Type
Content Type
  • application/json

Responses
Table 223. http response codes
Code Message Datatype

0

default response

[String]

Samples
delete4

DELETE /entitytoentitymapping/{mapId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

mapId

X

null

Return Type
Content Type
  • application/json

Responses
Table 224. http response codes
Code Message Datatype

0

default response

[String]

Samples
getEntityToEntityMappings

GET /entitytoentitymapping/{mapId}/{fromId}/{toId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

mapId

X

null

fromId

X

null

toId

X

null

Return Type
Content Type
  • application/json

Responses
Table 225. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveAll7

GET /entitytoentitymapping

Description
Parameters
Return Type
Content Type
  • application/json

Responses
Table 226. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveOne4

GET /entitytoentitymapping/{mapId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

mapId

X

null

Return Type
Content Type
  • application/json

Responses
Table 227. http response codes
Code Message Datatype

0

default response

[String]

Samples
updateMap

PUT /entitytoentitymapping/{mapId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

mapId

X

null

Body Parameter
Name Description Required Default Pattern

body

[string]

-

Return Type
Content Type
  • application/json

Responses
Table 228. http response codes
Code Message Datatype

0

default response

[String]

Samples

.1.40. FixedDepositAccount

accountClosureTemplate

GET /fixeddepositaccounts/{accountId}/template

Description
Parameters
Path Parameters
Name Description Required Default Pattern

accountId

accountId

X

null

Query Parameters
Name Description Required Default Pattern

command

command

-

null

Return Type
Content Type
  • application/json

Responses
Table 229. http response codes
Code Message Datatype

0

default response

[String]

Samples
delete14

DELETE /fixeddepositaccounts/{accountId}

Delete a fixed deposit application

Description

At present we support hard delete of fixed deposit application so long as its in 'Submitted and pending approval' state. One the application is moves past this state, it is not possible to do a 'hard' delete of the application or the account. An API endpoint will be added to close/de-activate the fixed deposit account.

Parameters
Path Parameters
Name Description Required Default Pattern

accountId

accountId

X

null

Return Type
Content Type
  • application/json

Responses
Table 230. http response codes
Code Message Datatype

200

OK

Section .2.43

Samples
getFixedDepositTemplate

GET /fixeddepositaccounts/downloadtemplate

Description
Parameters
Query Parameters
Name Description Required Default Pattern

officeId

-

null

staffId

-

null

dateFormat

-

null

Return Type

-

Content Type
  • application/vnd.ms-excel

Responses
Table 231. http response codes
Code Message Datatype

0

default response

<<>>

Samples
getFixedDepositTransactionTemplate

GET /fixeddepositaccounts/transaction/downloadtemplate

Description
Parameters
Query Parameters
Name Description Required Default Pattern

officeId

-

null

dateFormat

-

null

Return Type

-

Content Type
  • application/vnd.ms-excel

Responses
Table 232. http response codes
Code Message Datatype

0

default response

<<>>

Samples
handleCommands4

POST /fixeddepositaccounts/{accountId}

Approve fixed deposit application | Undo approval fixed deposit application | Reject fixed deposit application | Withdraw fixed deposit application | Activate a fixed deposit account | Close a fixed deposit account | Premature Close a fixed deposit account | Calculate Premature amount on Fixed deposit account | Calculate Interest on Fixed Deposit Account | Post Interest on Fixed Deposit Account

Description

Approve fixed deposit application: Approves fixed deposit application so long as its in 'Submitted and pending approval' state. Undo approval fixed deposit application: Will move 'approved' fixed deposit application back to 'Submitted and pending approval' state. Reject fixed deposit application: Rejects fixed deposit application so long as its in 'Submitted and pending approval' state. Withdraw fixed deposit application: Used when an applicant withdraws from the fixed deposit application. It must be in 'Submitted and pending approval' state. Close a fixed deposit account: Results in a Matured fixed deposit account being converted into a 'closed' fixed deposit account. Premature Close a fixed deposit account: Results in an Active fixed deposit account being converted into a 'Premature Closed' fixed deposit account with options to withdraw prematured amount. (premature amount is calculated using interest rate chart applicable along with penal interest if any.) Calculate Premature amount on Fixed deposit account: Calculate premature amount on fixed deposit account till premature close date. Premature amount is calculated based on interest chart and penal interest applicable. Calculate Interest on Fixed Deposit Account: Calculates interest earned on a fixed deposit account based on todays date. It does not attempt to post or credit the interest on the account. That is responsibility of the Post Interest API that will likely be called by overnight process. Post Interest on Fixed Deposit Account: Calculates and Posts interest earned on a fixed deposit account based on today’s date and whether an interest posting or crediting event is due. Showing request/response for Calculate Interest on Fixed Deposit Account

Parameters
Path Parameters
Name Description Required Default Pattern

accountId

accountId

X

null

Body Parameter
Name Description Required Default Pattern

body

[object]

X

Query Parameters
Name Description Required Default Pattern

command

command

-

null

Return Type
Content Type
  • application/json

Responses
Table 233. http response codes
Code Message Datatype

200

OK

Section .2.843

Samples
postFixedDepositTemplate

POST /fixeddepositaccounts/uploadtemplate

Description
Parameters
Form Parameters
Name Description Required Default Pattern

dateFormat

[string]

-

null

locale

[string]

-

null

uploadedInputStream

[file]

-

null

Return Type
Content Type
  • /

Responses
Table 234. http response codes
Code Message Datatype

0

default response

[String]

Samples
postFixedDepositTransactionTemplate

POST /fixeddepositaccounts/transaction/uploadtemplate

Description
Parameters
Form Parameters
Name Description Required Default Pattern

dateFormat

[string]

-

null

locale

[string]

-

null

uploadedInputStream

[file]

-

null

Return Type
Content Type
  • /

Responses
Table 235. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveAll29

GET /fixeddepositaccounts

List Fixed deposit applications/accounts

Description

Lists Fixed Deposit Accounts Example Requests: fixeddepositaccounts fixeddepositaccounts?fields=name

Parameters
Query Parameters
Name Description Required Default Pattern

paged

paged

-

null

offset

offset

-

null

limit

limit

-

null

orderBy

orderBy

-

null

sortOrder

sortOrder

-

null

Return Type
Content Type
  • application/json

Responses
Table 236. http response codes
Code Message Datatype

200

OK

List[Section .2.248]

Samples
retrieveOne18

GET /fixeddepositaccounts/{accountId}

Retrieve a fixed deposit application/account

Description

Retrieves a fixed deposit application/account Example Requests : fixeddepositaccounts/1 fixeddepositaccounts/1?associations=all

Parameters
Path Parameters
Name Description Required Default Pattern

accountId

accountId

X

null

Query Parameters
Name Description Required Default Pattern

staffInSelectedOfficeOnly

staffInSelectedOfficeOnly

-

false

chargeStatus

chargeStatus

-

all

Return Type
Content Type
  • application/json

Responses
Table 237. http response codes
Code Message Datatype

200

OK

Section .2.234

Samples
submitApplication

POST /fixeddepositaccounts

Submit new fixed deposit application

Description

Submits a new fixed deposit applicationMandatory Fields: clientId or groupId, productId, submittedOnDate, depositAmount, depositPeriod, depositPeriodFrequencyId Optional Fields: accountNo, externalId, fieldOfficerId,linkAccountId(if provided initial deposit amount will be collected from this account),transferInterestToSavings(By enabling this flag all interest postings will be transferred to linked saving account )

Parameters
Body Parameter
Name Description Required Default Pattern

PostFixedDepositAccountsRequest

Section .2.844

X

Return Type
Content Type
  • application/json

Responses
Table 238. http response codes
Code Message Datatype

200

OK

Section .2.845

Samples
template12

GET /fixeddepositaccounts/template

Retrieve Fixed Deposit Account Template

Description

This is a convenience resource. It can be useful when building maintenance user interface screens for fixed deposit applications. The template data returned consists of any or all of: Field Defaults Allowed Value ListsExample Requests: fixeddepositaccounts/template?clientId=1

Parameters
Query Parameters
Name Description Required Default Pattern

clientId

clientId

-

null

groupId

groupId

-

null

productId

productId

-

null

staffInSelectedOfficeOnly

staffInSelectedOfficeOnly

-

false

Return Type
Content Type
  • application/json

Responses
Table 239. http response codes
Code Message Datatype

200

OK

Section .2.251

Samples
update15

PUT /fixeddepositaccounts/{accountId}

Modify a fixed deposit application

Description

Fixed deposit application can only be modified when in 'Submitted and pending approval' state. Once the application is approved, the details cannot be changed using this method. Specific api endpoints will be created to allow change of interest detail such as rate, compounding period, posting period etc

Parameters
Path Parameters
Name Description Required Default Pattern

accountId

accountId

X

null

Body Parameter
Name Description Required Default Pattern

PutFixedDepositAccountsAccountIdRequest

Section .2.1038

X

Return Type
Content Type
  • application/json

Responses
Table 240. http response codes
Code Message Datatype

200

OK

Section .2.1039

Samples

.1.41. FixedDepositAccountTransactions

adjustTransaction

POST /fixeddepositaccounts/{fixedDepositAccountId}/transactions/{transactionId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

fixedDepositAccountId

X

null

transactionId

X

null

Body Parameter
Name Description Required Default Pattern

body

[string]

-

Query Parameters
Name Description Required Default Pattern

command

-

null

Return Type
Content Type
  • application/json

Responses
Table 241. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveOne17

GET /fixeddepositaccounts/{fixedDepositAccountId}/transactions/{transactionId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

fixedDepositAccountId

X

null

transactionId

X

null

Return Type
Content Type
  • application/json

Responses
Table 242. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveTemplate13

GET /fixeddepositaccounts/{fixedDepositAccountId}/transactions/template

Description
Parameters
Path Parameters
Name Description Required Default Pattern

fixedDepositAccountId

X

null

Return Type
Content Type
  • application/json

Responses
Table 243. http response codes
Code Message Datatype

0

default response

[String]

Samples
transaction

POST /fixeddepositaccounts/{fixedDepositAccountId}/transactions

Description
Parameters
Path Parameters
Name Description Required Default Pattern

fixedDepositAccountId

X

null

Body Parameter
Name Description Required Default Pattern

body

[string]

-

Query Parameters
Name Description Required Default Pattern

command

-

null

Return Type
Content Type
  • application/json

Responses
Table 244. http response codes
Code Message Datatype

0

default response

[String]

Samples

.1.42. FixedDepositProduct

create11

POST /fixeddepositproducts

Create a Fixed Deposit Product

Description

Creates a Fixed Deposit Product Mandatory Fields: name, shortName, description, currencyCode, digitsAfterDecimal,inMultiplesOf, interestCompoundingPeriodType, interestCalculationType, interestCalculationDaysInYearType, minDepositTerm, minDepositTermTypeId, accountingRule Optional Fields: lockinPeriodFrequency, lockinPeriodFrequencyType, maxDepositTerm, maxDepositTermTypeId, inMultiplesOfDepositTerm, inMultiplesOfDepositTermTypeId, preClosurePenalApplicable, preClosurePenalInterest, preClosurePenalInterestOnTypeId, feeToIncomeAccountMappings, penaltyToIncomeAccountMappings, charges, charts, , withHoldTax, taxGroupId Mandatory Fields for Cash based accounting (accountingRule = 2): savingsReferenceAccountId, savingsControlAccountId, interestOnSavingsAccountId, incomeFromFeeAccountId, transfersInSuspenseAccountId, incomeFromPenaltyAccountId

Parameters
Body Parameter
Name Description Required Default Pattern

PostFixedDepositProductsRequest

Section .2.848

X

Return Type
Content Type
  • application/json

Responses
Table 245. http response codes
Code Message Datatype

200

OK

Section .2.849

Samples
delete15

DELETE /fixeddepositproducts/{productId}

Delete a Fixed Deposit Product

Description

Deletes a Fixed Deposit Product

Parameters
Path Parameters
Name Description Required Default Pattern

productId

productId

X

null

Return Type
Content Type
  • application/json

Responses
Table 246. http response codes
Code Message Datatype

200

OK

Section .2.44

Samples
retrieveAll30

GET /fixeddepositproducts

List Fixed Deposit Products

Description

Lists Fixed Deposit Products Example Requests: fixeddepositproducts fixeddepositproducts?fields=name

Parameters
Return Type
Content Type
  • application/json

Responses
Table 247. http response codes
Code Message Datatype

200

OK

List[Section .2.282]

Samples
retrieveOne19

GET /fixeddepositproducts/{productId}

Retrieve a Fixed Deposit Product

Description

Retrieves a Fixed Deposit Product Example Requests: fixeddepositproducts/1 fixeddepositproducts/1?template=true fixeddepositproducts/1?fields=name,description

Parameters
Path Parameters
Name Description Required Default Pattern

productId

productId

X

null

Return Type
Content Type
  • application/json

Responses
Table 248. http response codes
Code Message Datatype

200

OK

Section .2.278

Samples
retrieveTemplate14

GET /fixeddepositproducts/template

Description
Parameters
Return Type
Content Type
  • application/json

Responses
Table 249. http response codes
Code Message Datatype

0

default response

[String]

Samples
update16

PUT /fixeddepositproducts/{productId}

Update a Fixed Deposit Product

Description

Updates a Fixed Deposit Product

Parameters
Path Parameters
Name Description Required Default Pattern

productId

productId

X

null

Body Parameter
Name Description Required Default Pattern

PutFixedDepositProductsProductIdRequest

Section .2.1042

X

Return Type
Content Type
  • application/json

Responses
Table 250. http response codes
Code Message Datatype

200

OK

Section .2.1043

Samples

.1.43. FloatingRates

createFloatingRate

POST /floatingrates

Create a new Floating Rate

Description

Creates a new Floating Rate Mandatory Fields: name Optional Fields: isBaseLendingRate, isActive, ratePeriods

Parameters
Body Parameter
Name Description Required Default Pattern

PostFloatingRatesRequest

Section .2.851

X

Return Type
Content Type
  • application/json

Responses
Table 251. http response codes
Code Message Datatype

200

OK

Section .2.852

Samples
retrieveAll22

GET /floatingrates

List Floating Rates

Description

Lists Floating Rates

Parameters
Return Type
Content Type
  • application/json

Responses
Table 252. http response codes
Code Message Datatype

200

OK

List[Section .2.285]

Samples
retrieveOne12

GET /floatingrates/{floatingRateId}

Retrieve Floating Rate

Description

Retrieves Floating Rate

Parameters
Path Parameters
Name Description Required Default Pattern

floatingRateId

floatingRateId

X

null

Return Type
Content Type
  • application/json

Responses
Table 253. http response codes
Code Message Datatype

200

OK

Section .2.283

Samples
updateFloatingRate

PUT /floatingrates/{floatingRateId}

Update Floating Rate

Description

Updates new Floating Rate. Rate Periods in the past cannot be modified. All the future rateperiods would be replaced with the new ratePeriods data sent.

Parameters
Path Parameters
Name Description Required Default Pattern

floatingRateId

floatingRateId

X

null

Body Parameter
Name Description Required Default Pattern

PutFloatingRatesFloatingRateIdRequest

Section .2.1045

X

Return Type
Content Type
  • application/json

Responses
Table 254. http response codes
Code Message Datatype

200

OK

Section .2.1046

Samples

.1.44. Funds

createFund

POST /funds

Create a Fund

Description

Creates a Fund

Parameters
Body Parameter
Name Description Required Default Pattern

PostFundsRequest

Section .2.853

X

Return Type
Content Type
  • application/json

Responses
Table 255. http response codes
Code Message Datatype

200

OK

Section .2.854

Samples
retreiveFund

GET /funds/{fundId}

Retrieve a Fund

Description

Returns the details of a Fund. Example Requests: funds/1

Parameters
Path Parameters
Name Description Required Default Pattern

fundId

fundId

X

null

Return Type
Content Type
  • application/json

Responses
Table 256. http response codes
Code Message Datatype

200

OK

Section .2.296

Samples
retrieveFunds

GET /funds

Retrieve Funds

Description

Returns the list of funds. Example Requests: funds

Parameters
Return Type
Content Type
  • application/json

Responses
Table 257. http response codes
Code Message Datatype

200

OK

List[Section .2.296]

Samples
updateFund

PUT /funds/{fundId}

Update a Fund

Description

Updates the details of a fund.

Parameters
Path Parameters
Name Description Required Default Pattern

fundId

fundId

X

null

Body Parameter
Name Description Required Default Pattern

PutFundsFundIdRequest

Section .2.1047

X

Return Type
Content Type
  • application/json

Responses
Table 258. http response codes
Code Message Datatype

200

OK

Section .2.1048

Samples

.1.45. GeneralLedgerAccount

createGLAccount1

POST /glaccounts

Create a General Ledger Account

Description

Note: You may optionally create Hierarchical Chart of Accounts by using the \"parentId\" property of an Account Mandatory Fields: name, glCode, type, usage and manualEntriesAllowed

Parameters
Body Parameter
Name Description Required Default Pattern

PostGLAccountsRequest

Section .2.855

-

Return Type
Content Type
  • application/json

Responses
Table 259. http response codes
Code Message Datatype

200

OK

Section .2.856

Samples
deleteGLAccount1

DELETE /glaccounts/{glAccountId}

Delete an accounting closure

Description

Note: Only the latest accounting closure associated with a branch may be deleted.

Parameters
Path Parameters
Name Description Required Default Pattern

glAccountId

glAccountId

X

null

Return Type
Content Type
  • application/json

Responses
Table 260. http response codes
Code Message Datatype

200

OK

Section .2.45

Samples
getGlAccountsTemplate

GET /glaccounts/downloadtemplate

Description
Parameters
Query Parameters
Name Description Required Default Pattern

dateFormat

-

null

Return Type

-

Content Type
  • application/vnd.ms-excel

Responses
Table 261. http response codes
Code Message Datatype

0

default response

<<>>

Samples
postGlAccountsTemplate

POST /glaccounts/uploadtemplate

Description
Parameters
Form Parameters
Name Description Required Default Pattern

dateFormat

[string]

-

null

locale

[string]

-

null

uploadedInputStream

[file]

-

null

Return Type
Content Type
  • /

Responses
Table 262. http response codes
Code Message Datatype

0

default response

[String]

Samples
retreiveAccount

GET /glaccounts/{glAccountId}

Retrieve a General Ledger Account

Description

Example Requests: glaccounts/1 glaccounts/1?template=true glaccounts/1?fields=name,glCode glaccounts/1?fetchRunningBalance=true

Parameters
Path Parameters
Name Description Required Default Pattern

glAccountId

glAccountId

X

null

Query Parameters
Name Description Required Default Pattern

fetchRunningBalance

fetchRunningBalance

-

null

Return Type
Content Type
  • application/json

Responses
Table 263. http response codes
Code Message Datatype

200

OK

Section .2.297

Samples
retrieveAllAccounts

GET /glaccounts

List General Ledger Accounts

Description

ARGUMENTS type Integer optional manualEntriesAllowed boolean optional usage Integer optional disabled boolean optional parentId Long optional tagId Long optional Example Requests: glaccounts glaccounts?type=1&manualEntriesAllowed=true&usage=1&disabled=false glaccounts?fetchRunningBalance=true

Parameters
Query Parameters
Name Description Required Default Pattern

type

type

-

null

searchParam

searchParam

-

null

usage

usage

-

null

manualEntriesAllowed

manualEntriesAllowed

-

null

disabled

disabled

-

null

fetchRunningBalance

fetchRunningBalance

-

null

Return Type
Content Type
  • application/json

Responses
Table 264. http response codes
Code Message Datatype

200

OK

List[Section .2.297]

Samples
retrieveNewAccountDetails

GET /glaccounts/template

Retrieve GL Accounts Template

Description

This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults Allowed Value Lists Example Request: glaccounts/template glaccounts/template?type=1 type is optional and integer value from 1 to 5. 1.Assets 2.Liabilities 3.Equity 4.Income 5.Expenses

Parameters
Query Parameters
Name Description Required Default Pattern

type

type

-

null

Return Type
Content Type
  • application/json

Responses
Table 265. http response codes
Code Message Datatype

200

OK

Section .2.298

Samples
updateGLAccount1

PUT /glaccounts/{glAccountId}

Update an Accounting closure

Description

Once an accounting closure is created, only the comments associated with it may be edited

Parameters
Path Parameters
Name Description Required Default Pattern

glAccountId

glAccountId

X

null

Body Parameter
Name Description Required Default Pattern

PutGLAccountsRequest

Section .2.1049

-

Return Type
Content Type
  • application/json

Responses
Table 266. http response codes
Code Message Datatype

200

OK

Section .2.1050

Samples

.1.46. GlobalConfiguration

retrieveConfiguration

GET /configurations

Retrieve Global Configuration | Retrieve Global Configuration for surveys

Description

Returns the list global enable/disable configurations. Example Requests: configurations Returns the list global enable/disable survey configurations. Example Requests: configurations/survey

Parameters
Query Parameters
Name Description Required Default Pattern

survey

survey

-

false

Return Type
Content Type
  • application/json

Responses
Table 267. http response codes
Code Message Datatype

200

List of example \\n response \\nsurveys response \\ngiven below

List[Section .2.300]

Samples
retrieveOne3

GET /configurations/{configId}

Retrieve Global Configuration

Description

Returns a global enable/disable configurations. Example Requests: configurations/1

Parameters
Path Parameters
Name Description Required Default Pattern

configId

configId

X

null

Return Type
Content Type
  • application/json

Responses
Table 268. http response codes
Code Message Datatype

200

OK

Section .2.300

Samples
retrieveOneByName

GET /configurations/name/{name}

Retrieve Global Configuration

Description

Returns a global enable/disable configuration. Example Requests: configurations/name/Enable-Address

Parameters
Path Parameters
Name Description Required Default Pattern

name

name

X

null

Return Type
Content Type
  • application/json

Responses
Table 269. http response codes
Code Message Datatype

200

OK

Section .2.732

Samples
updateConfiguration1

PUT /configurations/{configId}

Update Global Configuration

Description

Updates an enable/disable global configuration item.

Parameters
Path Parameters
Name Description Required Default Pattern

configId

configId

X

null

Body Parameter
Name Description Required Default Pattern

PutGlobalConfigurationsRequest

Section .2.1054

X

Return Type
Content Type
  • application/json

Responses
Table 270. http response codes
Code Message Datatype

200

OK

Section .2.1055

Samples

.1.47. Groups

activateOrGenerateCollectionSheet

POST /groups/{groupId}

Activate a Group | Associate Clients | Disassociate Clients | Transfer Clients across groups | Generate Collection Sheet | Save Collection Sheet | Unassign a Staff | Assign a Staff | Close a Group | Unassign a Role | Update a Role

Description

Activate a Group: Groups can be created in a Pending state. This API exists to enable group activation. If the group happens to be already active this API will result in an error. Mandatory Fields: activationDate Associate Clients: This API allows to associate existing clients to a group. The clients are listed from the office to which the group is associated. If client(s) is already associated with group then API will result in an error. Mandatory Fields: clientMembers Disassociate Clients: This API allows to disassociate clients from a group. Disassociating a client with active joint liability group loans results in an error. Mandatory Fields: clientMembers Transfer Clients across groups: This API allows to transfer clients from one group to another Mandatory Fields: destinationGroupId and clients Optional Fields: inheritDestinationGroupLoanOfficer (defaults to true) and transferActiveLoans (defaults to true) Generate Collection Sheet: This API retrieves repayment details of all jlg loans of all members of a group on a specified meeting date. Mandatory Fields: calendarId and transactionDate Save Collection Sheet: This api allows the loan officer to perform bulk repayments of JLG loans for a group on its meeting date. Mandatory Fields: calendarId, transactionDate, actualDisbursementDate Optional Fields: clientsAttendance, bulkRepaymentTransaction, bulkDisbursementTransactions Unassign a Staff: Allows you to unassign the Staff. Mandatory Fields: staffId Assign a Staff: Allows you to assign Staff to an existing Group. The selected Staff should be belong to the same office (or an office higher up in the hierarchy) as this groupMandatory Fields: staffId Optional Fields: inheritStaffForClientAccounts (Optional: Boolean if true all members of the group (i.e all clients with active loans and savings ) will inherit the staffId) Close a Group: This API exists to close a group. Groups can be closed if they don’t have any non-closed clients/loans/savingsAccounts. If the group has any active clients/loans/savingsAccount, this API will result in an error.Assign a Role: Allows you to assign a Role to an existing member of a group. We can define the different roles applicable to group members by adding code values to the pre-defined system code GROUPROLE. Example:Group leader etc. Mandatory Fields: clientId, role Unassign a Role: Allows you to unassign Roles associated tp Group members. Update a Role: Allows you to update the member Role. Mandatory Fields: role Showing request/response for Transfer Clients across groups

Parameters
Path Parameters
Name Description Required Default Pattern

groupId

groupId

X

null

Body Parameter
Name Description Required Default Pattern

PostGroupsGroupIdRequest

Section .2.862

X

Query Parameters
Name Description Required Default Pattern

command

command

-

null

roleId

roleId

-

null

Return Type
Content Type
  • application/json

Responses
Table 271. http response codes
Code Message Datatype

200

OK

Section .2.863

Samples
create8

POST /groups

Create a Group

Description

Creates a Group Mandatory Fields: name, officeId, active, activationDate (if active=true) Optional Fields: externalId, staffId, clientMembers

Parameters
Body Parameter
Name Description Required Default Pattern

PostGroupsRequest

Section .2.864

X

Return Type
Content Type
  • application/json

Responses
Table 272. http response codes
Code Message Datatype

200

OK

Section .2.865

Samples
delete11

DELETE /groups/{groupId}

Delete a Group

Description

A group can be deleted if it is in pending state and has no associations - clients, loans or savings

Parameters
Path Parameters
Name Description Required Default Pattern

groupId

groupId

X

null

Return Type
Content Type
  • application/json

Responses
Table 273. http response codes
Code Message Datatype

200

OK

Section .2.47

Samples
getGroupsTemplate

GET /groups/downloadtemplate

Description
Parameters
Query Parameters
Name Description Required Default Pattern

officeId

-

null

staffId

-

null

dateFormat

-

null

Return Type

-

Content Type
  • application/vnd.ms-excel

Responses
Table 274. http response codes
Code Message Datatype

0

default response

<<>>

Samples
postGroupTemplate

POST /groups/uploadtemplate

Description
Parameters
Form Parameters
Name Description Required Default Pattern

dateFormat

[string]

-

null

locale

[string]

-

null

uploadedInputStream

[file]

-

null

Return Type
Content Type
  • /

Responses
Table 275. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveAccounts

GET /groups/{groupId}/accounts

Retrieve Group accounts overview

Description

Retrieves details of all Loan and Savings accounts associated with this group. Example Requests: groups/1/accounts groups/1/accounts?fields=loanAccounts,savingsAccounts,memberLoanAccounts, memberSavingsAccounts

Parameters
Path Parameters
Name Description Required Default Pattern

groupId

groupId

X

null

Return Type
Content Type
  • application/json

Responses
Table 276. http response codes
Code Message Datatype

200

OK

Section .2.307

Samples
retrieveAll24

GET /groups

List Groups

Description

The default implementation of listing Groups returns 200 entries with support for pagination and sorting. Using the parameter limit with description -1 returns all entries. Example Requests: groups groups?fields=name,officeName,joinedDate groups?offset=10&limit=50 groups?orderBy=name&sortOrder=DESC

Parameters
Query Parameters
Name Description Required Default Pattern

officeId

officeId

-

null

staffId

staffId

-

null

externalId

externalId

-

null

name

name

-

null

underHierarchy

underHierarchy

-

null

paged

paged

-

null

offset

offset

-

null

limit

limit

-

null

orderBy

orderBy

-

null

sortOrder

sortOrder

-

null

orphansOnly

orphansOnly

-

null

Return Type
Content Type
  • application/json

Responses
Table 277. http response codes
Code Message Datatype

200

OK

Section .2.316

Samples
retrieveGsimAccounts

GET /groups/{groupId}/gsimaccounts

Description
Parameters
Path Parameters
Name Description Required Default Pattern

groupId

X

null

Query Parameters
Name Description Required Default Pattern

parentGSIMAccountNo

-

null

parentGSIMId

-

null

Return Type
Content Type
  • application/json

Responses
Table 278. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveOne14

GET /groups/{groupId}

Retrieve a Group

Description

Retrieve group information. Example Requests: groups/1 groups/1?associations=clientMembers

Parameters
Path Parameters
Name Description Required Default Pattern

groupId

groupId

X

null

Query Parameters
Name Description Required Default Pattern

staffInSelectedOfficeOnly

staffInSelectedOfficeOnly

-

false

roleId

roleId

-

null

Return Type
Content Type
  • application/json

Responses
Table 279. http response codes
Code Message Datatype

200

OK

Section .2.313

Samples
retrieveTemplate7

GET /groups/template

Retrieve Group Template

Description

This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults Allowed Value Lists Example Requests: groups/template groups/template?officeId=2 groups/template?centerId=1 groups/template?centerId=1&staffInSelectedOfficeOnly=true

Parameters
Query Parameters
Name Description Required Default Pattern

officeId

officeId

-

null

center

center

-

null

centerId

centerId

-

null

command

command

-

null

staffInSelectedOfficeOnly

staffInSelectedOfficeOnly

-

false

Return Type
Content Type
  • application/json

Responses
Table 280. http response codes
Code Message Datatype

200

OK

Section .2.322

Samples
retrieveglimAccounts

GET /groups/{groupId}/glimaccounts

Description
Parameters
Path Parameters
Name Description Required Default Pattern

groupId

X

null

Query Parameters
Name Description Required Default Pattern

parentLoanAccountNo

-

null

Return Type
Content Type
  • application/json

Responses
Table 281. http response codes
Code Message Datatype

0

default response

[String]

Samples
unassignLoanOfficer

POST /groups/{groupId}/command/unassign_staff

Unassign a Staff

Description

Allows you to unassign the Staff. Mandatory Fields: staffId

Parameters
Path Parameters
Name Description Required Default Pattern

groupId

groupId

X

null

Body Parameter
Name Description Required Default Pattern

PostGroupsGroupIdCommandUnassignStaffRequest

Section .2.860

X

Return Type
Content Type
  • application/json

Responses
Table 282. http response codes
Code Message Datatype

200

OK

Section .2.861

Samples
update12

PUT /groups/{groupId}

Update a Group

Description

Updates a Group

Parameters
Path Parameters
Name Description Required Default Pattern

groupId

groupId

X

null

Body Parameter
Name Description Required Default Pattern

PutGroupsGroupIdRequest

Section .2.1058

X

Return Type
Content Type
  • application/json

Responses
Table 283. http response codes
Code Message Datatype

200

OK

Section .2.1059

Samples

.1.48. GroupsLevel

retrieveAllGroups

GET /grouplevels

Description
Parameters
Return Type
Content Type
  • application/json

Responses
Table 284. http response codes
Code Message Datatype

0

default response

[String]

Samples

.1.49. Guarantors

accountsTemplate

GET /loans/{loanId}/guarantors/accounts/template

Description
Parameters
Path Parameters
Name Description Required Default Pattern

loanId

X

null

Query Parameters
Name Description Required Default Pattern

clientId

-

null

Return Type
Content Type
  • application/json

Responses
Table 285. http response codes
Code Message Datatype

0

default response

[String]

Samples
createGuarantor

POST /loans/{loanId}/guarantors

Description
Parameters
Path Parameters
Name Description Required Default Pattern

loanId

X

null

Body Parameter
Name Description Required Default Pattern

body

[string]

-

Return Type
Content Type
  • application/json

Responses
Table 286. http response codes
Code Message Datatype

0

default response

[String]

Samples
deleteGuarantor

DELETE /loans/{loanId}/guarantors/{guarantorId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

loanId

X

null

guarantorId

X

null

Query Parameters
Name Description Required Default Pattern

guarantorFundingId

-

null

Return Type
Content Type
  • application/json

Responses
Table 287. http response codes
Code Message Datatype

0

default response

[String]

Samples
getGuarantorTemplate

GET /loans/{loanId}/guarantors/downloadtemplate

Description
Parameters
Path Parameters
Name Description Required Default Pattern

loanId

X

null

Query Parameters
Name Description Required Default Pattern

officeId

-

null

dateFormat

-

null

Return Type

-

Content Type
  • application/vnd.ms-excel

Responses
Table 288. http response codes
Code Message Datatype

0

default response

<<>>

Samples
newGuarantorTemplate

GET /loans/{loanId}/guarantors/template

Description
Parameters
Path Parameters
Name Description Required Default Pattern

loanId

X

null

Return Type
Content Type
  • application/json

Responses
Table 289. http response codes
Code Message Datatype

0

default response

[String]

Samples
postGuarantorTemplate

POST /loans/{loanId}/guarantors/uploadtemplate

Description
Parameters
Path Parameters
Name Description Required Default Pattern

loanId

X

null

Form Parameters
Name Description Required Default Pattern

dateFormat

[string]

-

null

locale

[string]

-

null

uploadedInputStream

[file]

-

null

Return Type
Content Type
  • /

Responses
Table 290. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveGuarantorDetails

GET /loans/{loanId}/guarantors

Description
Parameters
Path Parameters
Name Description Required Default Pattern

loanId

X

null

Return Type
Content Type
  • application/json

Responses
Table 291. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveGuarantorDetails1

GET /loans/{loanId}/guarantors/{guarantorId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

loanId

X

null

guarantorId

X

null

Return Type
Content Type
  • application/json

Responses
Table 292. http response codes
Code Message Datatype

0

default response

[String]

Samples
updateGuarantor

PUT /loans/{loanId}/guarantors/{guarantorId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

loanId

X

null

guarantorId

X

null

Body Parameter
Name Description Required Default Pattern

body

[string]

-

Return Type
Content Type
  • application/json

Responses
Table 293. http response codes
Code Message Datatype

0

default response

[String]

Samples

.1.50. Holidays

createNewHoliday

POST /holidays

Create a Holiday

Description

Mandatory Fields: name, description, fromDate, toDate, repaymentsRescheduledTo, offices

Parameters
Body Parameter
Name Description Required Default Pattern

PostHolidaysRequest

Section .2.867

X

Return Type
Content Type
  • application/json

Responses
Table 294. http response codes
Code Message Datatype

200

OK

Section .2.869

Samples
delete7

DELETE /holidays/{holidayId}

Delete a Holiday

Description

This API allows to delete a holiday. This is a soft delete the deleted holiday status is marked as deleted.

Parameters
Path Parameters
Name Description Required Default Pattern

holidayId

holidayId

X

null

Return Type
Content Type
  • application/json

Responses
Table 295. http response codes
Code Message Datatype

200

OK

Section .2.48

Samples
handleCommands1

POST /holidays/{holidayId}

Activate a Holiday

Description

Always Holidays are created in pending state. This API allows to activate a holiday. Only the active holidays are considered for rescheduling the loan repayment.

Parameters
Path Parameters
Name Description Required Default Pattern

holidayId

holidayId

X

null

Body Parameter
Name Description Required Default Pattern

body

[object]

X

Query Parameters
Name Description Required Default Pattern

command

command

-

null

Return Type
Content Type
  • application/json

Responses
Table 296. http response codes
Code Message Datatype

200

OK

Section .2.866

Samples
retrieveAllHolidays

GET /holidays

List Holidays

Description

Example Requests: holidays?officeId=1

Parameters
Query Parameters
Name Description Required Default Pattern

officeId

officeId

-

null

fromDate

fromDate

-

null

toDate

toDate

-

null

locale

locale

-

null

dateFormat

dateFormat

-

null

Return Type
Content Type
  • application/json

Responses
Table 297. http response codes
Code Message Datatype

200

OK

List[Section .2.324]

Samples
retrieveOne7

GET /holidays/{holidayId}

Retrieve a Holiday

Description

Example Requests: holidays/1

Parameters
Path Parameters
Name Description Required Default Pattern

holidayId

holidayId

X

null

Return Type
Content Type
  • application/json

Responses
Table 298. http response codes
Code Message Datatype

200

OK

Section .2.324

Samples
retrieveRepaymentScheduleUpdationTyeOptions

GET /holidays/template

Description
Parameters
Return Type
Content Type
  • application/json

Responses
Table 299. http response codes
Code Message Datatype

0

default response

[String]

Samples
update6

PUT /holidays/{holidayId}

Update a Holiday

Description

If a holiday is in pending state (created and not activated) then all fields are allowed to modify. Once holidays become active only name and descriptions are allowed to modify.

Parameters
Path Parameters
Name Description Required Default Pattern

holidayId

holidayId

X

null

Body Parameter
Name Description Required Default Pattern

PutHolidaysHolidayIdRequest

Section .2.1060

X

Return Type
Content Type
  • application/json

Responses
Table 300. http response codes
Code Message Datatype

200

OK

Section .2.1061

Samples

.1.51. Hooks

createHook

POST /hooks

Create a Hook

Description

The following parameters can be passed for the creation of a hook :- name - string - Required. The name of the template that is being called. (See /hooks/template for the list of valid hook names.) isActive - boolean - Determines whether the hook is actually triggered. events - array - Determines what events the hook is triggered for. config - hash - Required. Key/value pairs to provide settings for this hook. These settings vary between the templates. templateId - Optional. The UGD template ID associated with the same entity (client or loan).

Parameters
Body Parameter
Name Description Required Default Pattern

PostHookRequest

Section .2.870

X

Return Type
Content Type
  • application/json

Responses
Table 301. http response codes
Code Message Datatype

200

OK

Section .2.871

Samples
deleteHook

DELETE /hooks/{hookId}

Delete a Hook

Description

Deletes a hook.

Parameters
Path Parameters
Name Description Required Default Pattern

hookId

hookId

X

null

Return Type
Content Type
  • application/json

Responses
Table 302. http response codes
Code Message Datatype

200

OK

Section .2.49

Samples
retrieveHook

GET /hooks/{hookId}

Retrieve a Hook

Description

Returns the details of a Hook. Example Requests: hooks/1

Parameters
Path Parameters
Name Description Required Default Pattern

hookId

hookId

X

null

Return Type
Content Type
  • application/json

Responses
Table 303. http response codes
Code Message Datatype

200

OK

Section .2.325

Samples
retrieveHooks

GET /hooks

Retrieve Hooks

Description

Returns the list of hooks. Example Requests: hooks

Parameters
Return Type
Content Type
  • application/json

Responses
Table 304. http response codes
Code Message Datatype

200

OK

List[Section .2.325]

Samples
template3

GET /hooks/template

Retrieve Hooks Template

Description

This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults Allowed description Lists Example Request: hooks/template

Parameters
Return Type
Content Type
  • application/json

Responses
Table 305. http response codes
Code Message Datatype

200

OK

Section .2.326

Samples
updateHook

PUT /hooks/{hookId}

Update a Hook

Description

Updates the details of a hook.

Parameters
Path Parameters
Name Description Required Default Pattern

hookId

hookId

X

null

Body Parameter
Name Description Required Default Pattern

PutHookRequest

Section .2.1063

X

Return Type
Content Type
  • application/json

Responses
Table 306. http response codes
Code Message Datatype

200

OK

Section .2.1064

Samples

.1.52. InterOperation

createQuote

POST /interoperation/quotes

Calculate Interoperation Quote

Description
Parameters
Body Parameter
Name Description Required Default Pattern

InteropQuoteRequestData

Section .2.746

X

Return Type
Content Type
  • application/json

Responses
Table 307. http response codes
Code Message Datatype

200

OK

Section .2.747

Samples
createTransactionRequest

POST /interoperation/requests

Allow Interoperation Transaction Request

Description
Parameters
Body Parameter
Name Description Required Default Pattern

InteropTransactionRequestData

Section .2.748

X

Return Type
Content Type
  • application/json

Responses
Table 308. http response codes
Code Message Datatype

200

OK

Section .2.749

Samples
deleteAccountIdentifier

DELETE /interoperation/parties/{idType}/{idValue}

Allow Interoperation Identifier registration

Description
Parameters
Path Parameters
Name Description Required Default Pattern

idType

idType

X

null

idValue

idValue

X

null

Body Parameter
Name Description Required Default Pattern

InteropIdentifierRequestData

Section .2.743

X

Return Type
Content Type
  • application/json

Responses
Table 309. http response codes
Code Message Datatype

200

OK

Section .2.742

Samples
deleteAccountIdentifier1

DELETE /interoperation/parties/{idType}/{idValue}/{subIdOrType}

Allow Interoperation Identifier registration

Description
Parameters
Path Parameters
Name Description Required Default Pattern

idType

idType

X

null

idValue

idValue

X

null

subIdOrType

subIdOrType

X

null

Body Parameter
Name Description Required Default Pattern

InteropIdentifierRequestData

Section .2.743

X

Return Type
Content Type
  • application/json

Responses
Table 310. http response codes
Code Message Datatype

200

OK

Section .2.742

Samples
disburseLoan

POST /interoperation/transactions/{accountId}/disburse

Disburse Loan by Account Id

Description
Parameters
Path Parameters
Name Description Required Default Pattern

accountId

accountId

X

null

Return Type
Content Type
  • application/json

Responses
Table 311. http response codes
Code Message Datatype

0

default response

[String]

Samples
getAccountByIdentifier

GET /interoperation/parties/{idType}/{idValue}

Query Interoperation Account by secondary identifier

Description
Parameters
Path Parameters
Name Description Required Default Pattern

idType

idType

X

null

idValue

idValue

X

null

Return Type
Content Type
  • application/json

Responses
Table 312. http response codes
Code Message Datatype

200

OK

Section .2.742

Samples
getAccountByIdentifier1

GET /interoperation/parties/{idType}/{idValue}/{subIdOrType}

Query Interoperation Account by secondary identifier

Description
Parameters
Path Parameters
Name Description Required Default Pattern

idType

idType

X

null

idValue

idValue

X

null

subIdOrType

subIdOrType

X

null

Return Type
Content Type
  • application/json

Responses
Table 313. http response codes
Code Message Datatype

200

OK

Section .2.742

Samples
getAccountDetails

GET /interoperation/accounts/{accountId}

Query Interoperation Account details

Description
Parameters
Path Parameters
Name Description Required Default Pattern

accountId

accountId

X

null

Return Type
Content Type
  • application/json

Responses
Table 314. http response codes
Code Message Datatype

200

OK

Section .2.741

Samples
getAccountIdentifiers

GET /interoperation/accounts/{accountId}/identifiers

Query Interoperation secondary identifiers by Account Id

Description
Parameters
Path Parameters
Name Description Required Default Pattern

accountId

accountId

X

null

Return Type
Content Type
  • application/json

Responses
Table 315. http response codes
Code Message Datatype

200

OK

Section .2.744

Samples
getAccountTransactions

GET /interoperation/accounts/{accountId}/transactions

Query transactions by Account Id

Description
Parameters
Path Parameters
Name Description Required Default Pattern

accountId

accountId

X

null

Query Parameters
Name Description Required Default Pattern

debit

debit

-

true

credit

credit

-

false

fromBookingDateTime

fromBookingDateTime

-

null

toBookingDateTime

toBookingDateTime

-

null

Return Type
Content Type
  • application/json

Responses
Table 316. http response codes
Code Message Datatype

200

OK

Section .2.751

Samples
getClientKyc

GET /interoperation/accounts/{accountId}/kyc

Query KYC by Account Id

Description
Parameters
Path Parameters
Name Description Required Default Pattern

accountId

accountId

X

null

Return Type
Content Type
  • application/json

Responses
Table 317. http response codes
Code Message Datatype

200

OK

Section .2.745

Samples
getQuote

GET /interoperation/transactions/{transactionCode}/quotes/{quoteCode}

Query Interoperation Quote

Description
Parameters
Path Parameters
Name Description Required Default Pattern

transactionCode

transactionCode

X

null

quoteCode

quoteCode

X

null

Return Type
Content Type
  • application/json

Responses
Table 318. http response codes
Code Message Datatype

200

OK

Section .2.747

Samples
getTransactionRequest

GET /interoperation/transactions/{transactionCode}/requests/{requestCode}

Query Interoperation Transaction Request

Description
Parameters
Path Parameters
Name Description Required Default Pattern

transactionCode

transactionCode

X

null

requestCode

requestCode

X

null

Return Type
Content Type
  • application/json

Responses
Table 319. http response codes
Code Message Datatype

200

OK

Section .2.749

Samples
getTransfer

GET /interoperation/transactions/{transactionCode}/transfers/{transferCode}

Query Interoperation Transfer

Description
Parameters
Path Parameters
Name Description Required Default Pattern

transactionCode

transactionCode

X

null

transferCode

transferCode

X

null

Return Type
Content Type
  • application/json

Responses
Table 320. http response codes
Code Message Datatype

200

OK

Section .2.753

Samples
health

GET /interoperation/health

Query Interoperation Health Request

Description
Parameters
Return Type

-

Responses
Table 321. http response codes
Code Message Datatype

200

OK

<<>>

Samples
performTransfer

POST /interoperation/transfers

Prepare Interoperation Transfer

Description
Parameters
Body Parameter
Name Description Required Default Pattern

InteropTransferRequestData

Section .2.752

X

Query Parameters
Name Description Required Default Pattern

action

action

-

null

Return Type
Content Type
  • application/json

Responses
Table 322. http response codes
Code Message Datatype

200

OK

Section .2.753

Samples
registerAccountIdentifier

POST /interoperation/parties/{idType}/{idValue}

Interoperation Identifier registration

Description
Parameters
Path Parameters
Name Description Required Default Pattern

idType

idType

X

null

idValue

idValue

X

null

Body Parameter
Name Description Required Default Pattern

InteropIdentifierRequestData

Section .2.743

X

Return Type
Content Type
  • application/json

Responses
Table 323. http response codes
Code Message Datatype

200

OK

Section .2.742

Samples
registerAccountIdentifier1

POST /interoperation/parties/{idType}/{idValue}/{subIdOrType}

Interoperation Identifier registration

Description
Parameters
Path Parameters
Name Description Required Default Pattern

idType

idType

X

null

idValue

idValue

X

null

subIdOrType

subIdOrType

X

null

Body Parameter
Name Description Required Default Pattern

InteropIdentifierRequestData

Section .2.743

X

Return Type
Content Type
  • application/json

Responses
Table 324. http response codes
Code Message Datatype

200

OK

Section .2.742

Samples

.1.53. InterestRateChart

create10

POST /interestratecharts

Create a Chart

Description

Creates a new chart which can be attached to a term deposit products (FD or RD).

Parameters
Body Parameter
Name Description Required Default Pattern

PostInterestRateChartsRequest

Section .2.875

X

Return Type
Content Type
  • application/json

Responses
Table 325. http response codes
Code Message Datatype

200

OK

Section .2.876

Samples
delete13

DELETE /interestratecharts/{chartId}

Delete a Chart

Description

It deletes the chart

Parameters
Path Parameters
Name Description Required Default Pattern

chartId

chartId

X

null

Return Type
Content Type
  • application/json

Responses
Table 326. http response codes
Code Message Datatype

200

OK

Section .2.51

Samples
retrieveAll26

GET /interestratecharts

Retrieve all Charts

Description

Retrieve list of charts associated with a term deposit product(FD or RD). Example Requests: interestratecharts?productId=1

Parameters
Query Parameters
Name Description Required Default Pattern

productId

productId

-

null

Return Type
Content Type
  • application/json

Responses
Table 327. http response codes
Code Message Datatype

200

OK

List[Section .2.339]

Samples
retrieveOne16

GET /interestratecharts/{chartId}

Retrieve a Chart

Description

It retrieves the Interest Rate Chart Example Requests: interestratecharts/1

Parameters
Path Parameters
Name Description Required Default Pattern

chartId

chartId

X

null

Return Type
Content Type
  • application/json

Responses
Table 328. http response codes
Code Message Datatype

200

OK

Section .2.339

Samples
template9

GET /interestratecharts/template

Retrieve Chart Details Template

Description

This is a convenience resource. It can be useful when building maintenance user interface screens for creating a chart. The template data returned consists of any or all of: Field Defaults Allowed Value Lists Example Request: interestratecharts/template

Parameters
Return Type
Content Type
  • application/json

Responses
Table 329. http response codes
Code Message Datatype

200

OK

Section .2.341

Samples
update14

PUT /interestratecharts/{chartId}

Update a Chart

Description

It updates the chart

Parameters
Path Parameters
Name Description Required Default Pattern

chartId

chartId

X

null

Body Parameter
Name Description Required Default Pattern

PutInterestRateChartsChartIdRequest

Section .2.1068

X

Return Type
Content Type
  • application/json

Responses
Table 330. http response codes
Code Message Datatype

200

OK

Section .2.1069

Samples

.1.54. InterestRateSlabAKAInterestBands

create9

POST /interestratecharts/{chartId}/chartslabs

Create a Slab

Description

Creates a new interest rate slab for an interest rate chart. Mandatory Fields periodType, fromPeriod, annualInterestRate Optional Fields toPeriod and description Example Requests: interestratecharts/1/chartslabs

Parameters
Path Parameters
Name Description Required Default Pattern

chartId

chartId

X

null

Body Parameter
Name Description Required Default Pattern

PostInterestRateChartsChartIdChartSlabsRequest

Section .2.873

X

Return Type
Content Type
  • application/json

Responses
Table 331. http response codes
Code Message Datatype

200

OK

Section .2.874

Samples
delete12

DELETE /interestratecharts/{chartId}/chartslabs/{chartSlabId}

Delete a Slab

Description

Delete a Slab from a chart

Parameters
Path Parameters
Name Description Required Default Pattern

chartId

chartId

X

null

chartSlabId

chartSlabId

X

null

Return Type
Content Type
  • application/json

Responses
Table 332. http response codes
Code Message Datatype

200

OK

Section .2.50

Samples
retrieveAll25

GET /interestratecharts/{chartId}/chartslabs

Retrieve all Slabs

Description

Retrieve list of slabs associated with a chart Example Requests: interestratecharts/1/chartslabs

Parameters
Path Parameters
Name Description Required Default Pattern

chartId

chartId

X

null

Return Type
Content Type
  • application/json

Responses
Table 333. http response codes
Code Message Datatype

200

OK

List[Section .2.336]

Samples
retrieveOne15

GET /interestratecharts/{chartId}/chartslabs/{chartSlabId}

Retrieve a Slab

Description

Retrieve a slab associated with an Interest rate chart Example Requests: interestratecharts/1/chartslabs/1

Parameters
Path Parameters
Name Description Required Default Pattern

chartId

chartId

X

null

chartSlabId

chartSlabId

X

null

Return Type
Content Type
  • application/json

Responses
Table 334. http response codes
Code Message Datatype

200

OK

Section .2.336

Samples
template8

GET /interestratecharts/{chartId}/chartslabs/template

Description
Parameters
Path Parameters
Name Description Required Default Pattern

chartId

chartId

X

null

Return Type
Content Type
  • application/json

Responses
Table 335. http response codes
Code Message Datatype

0

default response

[String]

Samples
update13

PUT /interestratecharts/{chartId}/chartslabs/{chartSlabId}

Update a Slab

Description

It updates the Slab from chart

Parameters
Path Parameters
Name Description Required Default Pattern

chartId

chartId

X

null

chartSlabId

chartSlabId

X

null

Body Parameter
Name Description Required Default Pattern

PutInterestRateChartsChartIdChartSlabsChartSlabIdRequest

Section .2.1066

X

Return Type
Content Type
  • application/json

Responses
Table 336. http response codes
Code Message Datatype

200

OK

Section .2.1067

Samples

.1.55. JournalEntries

createGLJournalEntry

POST /journalentries

Create \"Balanced\" Journal Entries

Description

Note: A Balanced (simple) Journal entry would have atleast one \"Debit\" and one \"Credit\" entry whose amounts are equal Compound Journal entries may have \"n\" debits and \"m\" credits where both \"m\" and \"n\" are greater than 0 and the net sum or all debits and credits are equal Mandatory Fields officeId, transactionDate credits- glAccountId, amount, comments debits- glAccountId, amount, comments Optional Fields paymentTypeId, accountNumber, checkNumber, routingCode, receiptNumber, bankNumber

Parameters
Body Parameter
Name Description Required Default Pattern

JournalEntryCommand

Section .2.755

-

Query Parameters
Name Description Required Default Pattern

command

command

-

null

Return Type
Content Type
  • application/json

Responses
Table 337. http response codes
Code Message Datatype

200

OK

Section .2.877

Samples
createReversalJournalEntry

POST /journalentries/{transactionId}

Update Running balances for Journal Entries

Description

This API calculates the running balances for office. If office ID not provided this API calculates running balances for all offices. Mandatory Fields officeId

Parameters
Path Parameters
Name Description Required Default Pattern

transactionId

transactionId

X

null

Body Parameter
Name Description Required Default Pattern

PostJournalEntriesTransactionIdRequest

Section .2.878

-

Query Parameters
Name Description Required Default Pattern

command

command

-

null

Return Type
Content Type
  • application/json

Responses
Table 338. http response codes
Code Message Datatype

200

OK

Section .2.879

Samples
getJournalEntriesTemplate

GET /journalentries/downloadtemplate

Description
Parameters
Query Parameters
Name Description Required Default Pattern

officeId

-

null

dateFormat

-

null

Return Type

-

Content Type
  • application/vnd.ms-excel

Responses
Table 339. http response codes
Code Message Datatype

0

default response

<<>>

Samples
postJournalEntriesTemplate

POST /journalentries/uploadtemplate

Description
Parameters
Form Parameters
Name Description Required Default Pattern

dateFormat

[string]

-

null

locale

[string]

-

null

uploadedInputStream

[file]

-

null

Return Type
Content Type
  • /

Responses
Table 340. http response codes
Code Message Datatype

0

default response

[String]

Samples
retreiveJournalEntryById

GET /journalentries/{journalEntryId}

Retrieve a single Entry

Description

Example Requests: journalentries/1 journalentries/1?fields=officeName,glAccountId,entryType,amount journalentries/1?runningBalance=true journalentries/1?transactionDetails=true

Parameters
Path Parameters
Name Description Required Default Pattern

journalEntryId

journalEntryId

X

null

Query Parameters
Name Description Required Default Pattern

runningBalance

runningBalance

-

null

transactionDetails

transactionDetails

-

null

Return Type
Content Type
  • application/json

Responses
Table 341. http response codes
Code Message Datatype

200

OK

Section .2.756

Samples
retrieveAll1

GET /journalentries

List Journal Entries

Description

The list capability of journal entries can support pagination and sorting. Example Requests: journalentries journalentries?transactionId=PB37X8Y21EQUY4S journalentries?officeId=1&manualEntriesOnly=true&fromDate=1 July 2013&toDate=15 July 2013&dateFormat=dd MMMM yyyy&locale=en journalentries?fields=officeName,glAccountName,transactionDate journalentries?offset=10&limit=50 journalentries?orderBy=transactionId&sortOrder=DESC journalentries?runningBalance=true journalentries?transactionDetails=true journalentries?loanId=12 journalentries?savingsId=24

Parameters
Query Parameters
Name Description Required Default Pattern

officeId

officeId

-

null

glAccountId

glAccountId

-

null

manualEntriesOnly

manualEntriesOnly

-

null

fromDate

fromDate

-

null

toDate

toDate

-

null

transactionId

transactionId

-

null

entityType

entityType

-

null

offset

offset

-

null

limit

limit

-

null

orderBy

orderBy

-

null

sortOrder

sortOrder

-

null

locale

locale

-

null

dateFormat

dateFormat

-

null

loanId

loanId

-

null

savingsId

savingsId

-

null

runningBalance

runningBalance

-

null

transactionDetails

transactionDetails

-

null

Return Type
Content Type
  • application/json

Responses
Table 342. http response codes
Code Message Datatype

200

OK

List[Section .2.756]

Samples
retrieveJournalEntries

GET /journalentries/provisioning

Description
Parameters
Query Parameters
Name Description Required Default Pattern

offset

-

null

limit

-

null

entryId

-

null

Return Type
Content Type
  • application/json

Responses
Table 343. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveOpeningBalance

GET /journalentries/openingbalance

Description
Parameters
Query Parameters
Name Description Required Default Pattern

officeId

-

null

currencyCode

-

null

Return Type
Content Type
  • application/json

Responses
Table 344. http response codes
Code Message Datatype

0

default response

[String]

Samples

.1.56. Likelihood

retrieve

GET /likelihood/{ppiName}/{likelihoodId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

likelihoodId

X

null

ppiName

X

null

Return Type
Content Type
  • application/json

Responses
Table 345. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveAll11

GET /likelihood/{ppiName}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

ppiName

X

null

Return Type
Content Type
  • application/json

Responses
Table 346. http response codes
Code Message Datatype

0

default response

[String]

Samples
update4

PUT /likelihood/{ppiName}/{likelihoodId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

likelihoodId

X

null

ppiName

X

null

Body Parameter
Name Description Required Default Pattern

body

[string]

-

Return Type
Content Type
  • application/json

Responses
Table 347. http response codes
Code Message Datatype

0

default response

[String]

Samples

.1.57. ListReportMailingJobHistory

retrieveAllByReportMailingJobId

GET /reportmailingjobrunhistory

List Report Mailing Job History

Description

The list capability of report mailing job history can support pagination and sorting. Example Requests: reportmailingjobrunhistory/1

Parameters
Query Parameters
Name Description Required Default Pattern

reportMailingJobId

reportMailingJobId

-

null

offset

offset

-

null

limit

limit

-

null

orderBy

orderBy

-

null

sortOrder

sortOrder

-

null

Return Type
Content Type
  • application/json

Responses
Table 348. http response codes
Code Message Datatype

200

OK

Section .2.1161

Samples

.1.58. LoanCharges

deleteLoanCharge

DELETE /loans/{loanId}/charges/{chargeId}

Delete a Loan Charge

Description

Note: Currently, A Loan Charge may only be removed from Loans that are not yet approved.

Parameters
Path Parameters
Name Description Required Default Pattern

loanId

loanId

X

null

chargeId

chargeId

X

null

Return Type
Content Type
  • application/json

Responses
Table 349. http response codes
Code Message Datatype

200

OK

Section .2.52

Samples
executeLoanCharge

POST /loans/{loanId}/charges

Create a Loan Charge

Description

It Creates a Loan Charge

Parameters
Path Parameters
Name Description Required Default Pattern

loanId

loanId

X

null

Body Parameter
Name Description Required Default Pattern

PostLoansLoanIdChargesRequest

Section .2.886

X

Query Parameters
Name Description Required Default Pattern

command

command

-

null

Return Type
Content Type
  • application/json

Responses
Table 350. http response codes
Code Message Datatype

200

OK

Section .2.887

Samples
executeLoanCharge1

POST /loans/{loanId}/charges/{chargeId}

Pay Loan Charge

Description

Loan Charge will be paid if the loan is linked with a savings account

Parameters
Path Parameters
Name Description Required Default Pattern

loanId

loanId

X

null

chargeId

chargeId

X

null

Body Parameter
Name Description Required Default Pattern

PostLoansLoanIdChargesChargeIdRequest

Section .2.884

X

Query Parameters
Name Description Required Default Pattern

command

command

-

null

Return Type
Content Type
  • application/json

Responses
Table 351. http response codes
Code Message Datatype

200

OK

Section .2.885

Samples
retrieveAllLoanCharges

GET /loans/{loanId}/charges

List Loan Charges

Description

It lists all the Loan Charges specific to a Loan Example Requests: loans/1/charges loans/1/charges?fields=name,amountOrPercentage

Parameters
Path Parameters
Name Description Required Default Pattern

loanId

loanId

X

null

Return Type
Content Type
  • application/json

Responses
Table 352. http response codes
Code Message Datatype

200

OK

List[Section .2.410]

Samples
retrieveLoanCharge

GET /loans/{loanId}/charges/{chargeId}

Retrieve a Loan Charge

Description

Retrieves Loan Charge according to the Loan ID and Charge IDExample Requests: /loans/1/charges/1 /loans/1/charges/1?fields=name,amountOrPercentage

Parameters
Path Parameters
Name Description Required Default Pattern

loanId

loanId

X

null

chargeId

chargeId

X

null

Return Type
Content Type
  • application/json

Responses
Table 353. http response codes
Code Message Datatype

200

OK

Section .2.410

Samples
retrieveTemplate8

GET /loans/{loanId}/charges/template

Retrieve Loan Charges Template

Description

This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults Allowed description Lists Example Request: loans/1/charges/template

Parameters
Path Parameters
Name Description Required Default Pattern

loanId

loanId

X

null

Return Type
Content Type
  • application/json

Responses
Table 354. http response codes
Code Message Datatype

200

OK

Section .2.411

Samples
updateLoanCharge

PUT /loans/{loanId}/charges/{chargeId}

Update a Loan Charge

Description

Currently Loan Charges may be updated only if the Loan is not yet approved

Parameters
Path Parameters
Name Description Required Default Pattern

loanId

loanId

X

null

chargeId

chargeId

X

null

Body Parameter
Name Description Required Default Pattern

PutLoansLoanIdChargesChargeIdRequest

Section .2.1075

X

Return Type
Content Type
  • application/json

Responses
Table 355. http response codes
Code Message Datatype

200

OK

Section .2.1076

Samples

.1.59. LoanCollateral

createCollateral

POST /loans/{loanId}/collaterals

Create a Collateral

Description

Note: Currently, Collaterals may be added only before a Loan is approved

Parameters
Path Parameters
Name Description Required Default Pattern

loanId

loanId

X

null

Body Parameter
Name Description Required Default Pattern

PostLoansLoanIdCollateralsRequest

Section .2.888

X

Return Type
Content Type
  • application/json

Responses
Table 356. http response codes
Code Message Datatype

200

OK

Section .2.889

Samples
deleteCollateral

DELETE /loans/{loanId}/collaterals/{collateralId}

Remove a Collateral

Description

Note: A collateral can only be removed from Loans that are not yet approved.

Parameters
Path Parameters
Name Description Required Default Pattern

loanId

loanId

X

null

collateralId

collateralId

X

null

Return Type
Content Type
  • application/json

Responses
Table 357. http response codes
Code Message Datatype

200

OK

Section .2.53

Samples
newCollateralTemplate

GET /loans/{loanId}/collaterals/template

Retrieve Collateral Details Template

Description

This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults Allowed Value Lists Example Request: loans/1/collaterals/template

Parameters
Path Parameters
Name Description Required Default Pattern

loanId

loanId

X

null

Return Type
Content Type
  • application/json

Responses
Table 358. http response codes
Code Message Datatype

200

OK

Section .2.413

Samples
retrieveCollateralDetails

GET /loans/{loanId}/collaterals

List Loan Collaterals

Description

Example Requests: loans/1/collaterals loans/1/collaterals?fields=value,description

Parameters
Path Parameters
Name Description Required Default Pattern

loanId

loanId

X

null

Return Type
Content Type
  • application/json

Responses
Table 359. http response codes
Code Message Datatype

200

OK

List[Section .2.412]

Samples
retrieveCollateralDetails1

GET /loans/{loanId}/collaterals/{collateralId}

Retrieve a Collateral

Description

Example Requests: /loans/1/collaterals/1 /loans/1/collaterals/1?fields=description,description

Parameters
Path Parameters
Name Description Required Default Pattern

loanId

loanId

X

null

collateralId

collateralId

X

null

Return Type
Content Type
  • application/json

Responses
Table 360. http response codes
Code Message Datatype

200

OK

Section .2.412

Samples
updateCollateral

PUT /loans/{loanId}/collaterals/{collateralId}

Update a Collateral

Description
Parameters
Path Parameters
Name Description Required Default Pattern

loanId

loanId

X

null

collateralId

collateralId

X

null

Body Parameter
Name Description Required Default Pattern

PutLoansLoandIdCollateralsCollateralIdRequest

Section .2.1080

X

Return Type
Content Type
  • application/json

Responses
Table 361. http response codes
Code Message Datatype

200

OK

Section .2.1077

Samples

.1.60. LoanCollateralManagement

deleteLoanCollateral

DELETE /loan-collateral-management/{id}

Delete Loan Collateral

Description

Delete Loan Collateral

Parameters
Path Parameters
Name Description Required Default Pattern

loanId

loanId

X

null

id

loan collateral id

X

null

Return Type
Content Type
  • application/json

Responses
Table 362. http response codes
Code Message Datatype

0

default response

[String]

Samples
getLoanCollateral

GET /loan-collateral-management/{collateralId}

Get Loan Collateral Details

Description

Get Loan Collateral Details

Parameters
Path Parameters
Name Description Required Default Pattern

collateralId

collateralId

X

null

Return Type
Content Type
  • application/json

Responses
Table 363. http response codes
Code Message Datatype

0

default response

[String]

Samples

.1.61. LoanDisbursementDetails

addAndDeleteDisbursementDetail

PUT /loans/{loanId}/disbursements/editDisbursements

Description
Parameters
Path Parameters
Name Description Required Default Pattern

loanId

X

null

Body Parameter
Name Description Required Default Pattern

body

[string]

-

Return Type
Content Type
  • application/json

Responses
Table 364. http response codes
Code Message Datatype

0

default response

[String]

Samples
retriveDetail

GET /loans/{loanId}/disbursements/{disbursementId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

loanId

X

null

disbursementId

X

null

Return Type
Content Type
  • application/json

Responses
Table 365. http response codes
Code Message Datatype

0

default response

[String]

Samples
updateDisbursementDate

PUT /loans/{loanId}/disbursements/{disbursementId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

loanId

X

null

disbursementId

X

null

Body Parameter
Name Description Required Default Pattern

body

[string]

-

Return Type
Content Type
  • application/json

Responses
Table 366. http response codes
Code Message Datatype

0

default response

[String]

Samples

.1.62. LoanProducts

createLoanProduct

POST /loanproducts

Create a Loan Product

Description

Depending of the Accounting Rule (accountingRule) selected, additional fields with details of the appropriate Ledger Account identifiers would need to be passed in. Refer MifosX Accounting Specs Draft for more details regarding the significance of the selected accounting rule Mandatory Fields: name, shortName, currencyCode, digitsAfterDecimal, inMultiplesOf, principal, numberOfRepayments, repaymentEvery, repaymentFrequencyType, interestRatePerPeriod, interestRateFrequencyType, amortizationType, interestType, interestCalculationPeriodType, transactionProcessingStrategyId, accountingRule, isInterestRecalculationEnabled, daysInYearType, daysInMonthType Optional Fields: inArrearsTolerance, graceOnPrincipalPayment, graceOnInterestPayment, graceOnInterestCharged, graceOnArrearsAgeing, charges, paymentChannelToFundSourceMappings, feeToIncomeAccountMappings, penaltyToIncomeAccountMappings, includeInBorrowerCycle, useBorrowerCycle,principalVariationsForBorrowerCycle, numberOfRepaymentVariationsForBorrowerCycle, interestRateVariationsForBorrowerCycle, multiDisburseLoan,maxTrancheCount, outstandingLoanBalance,overdueDaysForNPA,holdGuaranteeFunds, principalThresholdForLastInstalment, accountMovesOutOfNPAOnlyOnArrearsCompletion, canDefineInstallmentAmount, installmentAmountInMultiplesOf, allowAttributeOverrides, allowPartialPeriodInterestCalcualtion Additional Mandatory Fields for Cash(2) based accounting: fundSourceAccountId, loanPortfolioAccountId, interestOnLoanAccountId, incomeFromFeeAccountId, incomeFromPenaltyAccountId, writeOffAccountId, transfersInSuspenseAccountId, overpaymentLiabilityAccountId Additional Mandatory Fields for periodic (3) and upfront (4)accrual accounting: fundSourceAccountId, loanPortfolioAccountId, interestOnLoanAccountId, incomeFromFeeAccountId, incomeFromPenaltyAccountId, writeOffAccountId, receivableInterestAccountId, receivableFeeAccountId, receivablePenaltyAccountId, transfersInSuspenseAccountId, overpaymentLiabilityAccountId Additional Mandatory Fields if interest recalculation is enabled(true): interestRecalculationCompoundingMethod, rescheduleStrategyMethod, recalculationRestFrequencyType Additional Optional Fields if interest recalculation is enabled(true): isArrearsBasedOnOriginalSchedule, preClosureInterestCalculationStrategy Additional Optional Fields if interest recalculation is enabled(true) and recalculationRestFrequencyType is not same as repayment period: recalculationRestFrequencyInterval, recalculationRestFrequencyDate Additional Optional Fields if interest recalculation is enabled(true) and interestRecalculationCompoundingMethod is enabled: recalculationCompoundingFrequencyType Additional Optional Fields if interest recalculation is enabled(true) and interestRecalculationCompoundingMethod is enabled and recalculationCompoundingFrequencyType is not same as repayment period: recalculationCompoundingFrequencyInterval, recalculationCompoundingFrequencyDate Additional Mandatory Fields if Hold Guarantee funds is enabled(true): mandatoryGuarantee Additional Optional Fields if Hold Guarantee funds is enabled(true): minimumGuaranteeFromOwnFunds,minimumGuaranteeFromGuarantor

Parameters
Body Parameter
Name Description Required Default Pattern

PostLoanProductsRequest

Section .2.882

X

Return Type
Content Type
  • application/json

Responses
Table 367. http response codes
Code Message Datatype

200

OK

Section .2.883

Samples
retrieveAllLoanProducts

GET /loanproducts

List Loan Products

Description

Lists Loan Products Example Requests: loanproducts loanproducts?fields=name,description,interestRateFrequencyType,amortizationType

Parameters
Return Type
Content Type
  • application/json

Responses
Table 368. http response codes
Code Message Datatype

200

OK

List[Section .2.396]

Samples
retrieveLoanProductDetails

GET /loanproducts/{productId}

Retrieve a Loan Product

Description

Retrieves a Loan Product Example Requests: loanproducts/1 loanproducts/1?template=true loanproducts/1?fields=name,description,numberOfRepayments

Parameters
Path Parameters
Name Description Required Default Pattern

productId

productId

X

null

Return Type
Content Type
  • application/json

Responses
Table 369. http response codes
Code Message Datatype

200

OK

Section .2.392

Samples
retrieveTemplate10

GET /loanproducts/template

Retrieve Loan Product Details Template

Description

This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults Allowed description Lists Example Request: loanproducts/template

Parameters
Query Parameters
Name Description Required Default Pattern

isProductMixTemplate

isProductMixTemplate

-

null

Return Type
Content Type
  • application/json

Responses
Table 370. http response codes
Code Message Datatype

200

OK

Section .2.398

Samples
updateLoanProduct

PUT /loanproducts/{productId}

Update a Loan Product

Description

Updates a Loan Product

Parameters
Path Parameters
Name Description Required Default Pattern

productId

productId

X

null

Body Parameter
Name Description Required Default Pattern

PutLoanProductsProductIdRequest

Section .2.1072

X

Return Type
Content Type
  • application/json

Responses
Table 371. http response codes
Code Message Datatype

200

OK

Section .2.1073

Samples

.1.63. LoanRescheduling

calculateLoanScheduleOrSubmitVariableSchedule

POST /loans/{loanId}/schedule

Calculate loan repayment schedule based on Loan term variations | Updates loan repayment schedule based on Loan term variations | Updates loan repayment schedule by removing Loan term variations

Description

Calculate loan repayment schedule based on Loan term variations: Mandatory Fields: exceptions,locale,dateFormat Updates loan repayment schedule based on Loan term variations: Mandatory Fields: exceptions,locale,dateFormat Updates loan repayment schedule by removing Loan term variations: It updates the loan repayment schedule by removing Loan term variations Showing request/response for 'Updates loan repayment schedule by removing Loan term variations'

Parameters
Path Parameters
Name Description Required Default Pattern

loanId

loanId

X

null

Body Parameter
Name Description Required Default Pattern

body

[object]

X

Query Parameters
Name Description Required Default Pattern

command

command

-

null

Return Type
Content Type
  • application/json

Responses
Table 372. http response codes
Code Message Datatype

200

OK

Section .2.892

Samples

.1.64. LoanTransactions

adjustLoanTransaction

POST /loans/{loanId}/transactions/{transactionId}

Adjust a Transaction

Description

Note: there is no need to specify command={transactionType} parameter. Mandatory Fields: transactionDate, transactionAmount

Parameters
Path Parameters
Name Description Required Default Pattern

loanId

loanId

X

null

transactionId

transactionId

X

null

Body Parameter
Name Description Required Default Pattern

PostLoansLoanIdTransactionsTransactionIdRequest

Section .2.894

X

Return Type
Content Type
  • application/json

Responses
Table 373. http response codes
Code Message Datatype

200

OK

Section .2.895

Samples
executeLoanTransaction

POST /loans/{loanId}/transactions

Significant Loan Transactions

Description

This API covers the major loan transaction functionality Example Requests: loans/1/transactions?command=repayment | Make a Repayment | loans/1/transactions?command=merchantIssuedRefund | Merchant Issued Refund | loans/1/transactions?command=payoutRefund | Payout Refund | loans/1/transactions?command=goodwillCredit | Goodwil Credit | loans/1/transactions?command=waiveinterest | Waive Interest | loans/1/transactions?command=writeoff | Write-off Loan | loans/1/transactions?command=close-rescheduled | Close Rescheduled Loan | loans/1/transactions?command=close | Close Loan | loans/1/transactions?command=undowriteoff | Undo Loan Write-off | loans/1/transactions?command=recoverypayment | Make Recovery Payment | loans/1/transactions?command=refundByCash | Make a Refund of an Active Loan by Cash | loans/1/transactions?command=foreclosure | Foreclosure of an Active Loan | loans/1/transactions?command=creditBalanceRefund | Credit Balance Refund |

Parameters
Path Parameters
Name Description Required Default Pattern

loanId

loanId

X

null

Body Parameter
Name Description Required Default Pattern

body

[object]

X

Query Parameters
Name Description Required Default Pattern

command

command

-

null

Return Type
Content Type
  • application/json

Responses
Table 374. http response codes
Code Message Datatype

200

OK

Section .2.893

Samples
retrieveTransaction

GET /loans/{loanId}/transactions/{transactionId}

Retrieve a Transaction Details

Description

Retrieves a Transaction Details Example Request: loans/5/transactions/3

Parameters
Path Parameters
Name Description Required Default Pattern

loanId

loanId

X

null

transactionId

transactionId

X

null

Return Type
Content Type
  • application/json

Responses
Table 375. http response codes
Code Message Datatype

200

OK

Section .2.430

Samples
retrieveTransactionTemplate

GET /loans/{loanId}/transactions/template

Retrieve Loan Transaction Template

Description

This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults Allowed Value Lists Example Requests: loans/1/transactions/template?command=repaymentloans/1/transactions/template?command=merchantIssuedRefundloans/1/transactions/template?command=payoutRefundloans/1/transactions/template?command=goodwillCredit loans/1/transactions/template?command=waiveinterest loans/1/transactions/template?command=writeoff loans/1/transactions/template?command=close-rescheduled loans/1/transactions/template?command=close loans/1/transactions/template?command=disburse loans/1/transactions/template?command=disburseToSavings loans/1/transactions/template?command=recoverypayment loans/1/transactions/template?command=prepayLoan loans/1/transactions/template?command=refundbycash loans/1/transactions/template?command=refundbytransfer loans/1/transactions/template?command=foreclosure loans/1/transactions/template?command=creditBalanceRefund (returned 'amount' field will have the overpaid value

Parameters
Path Parameters
Name Description Required Default Pattern

loanId

loanId

X

null

Query Parameters
Name Description Required Default Pattern

command

command

-

null

dateFormat

dateFormat

-

null

transactionDate

transactionDate

-

null

locale

locale

-

null

Return Type
Content Type
  • application/json

Responses
Table 376. http response codes
Code Message Datatype

200

OK

Section .2.429

Samples
undoWaiveCharge

PUT /loans/{loanId}/transactions/{transactionId}

Undo a Waive Charge Transaction

Description

Undo a Waive Charge Transaction

Parameters
Path Parameters
Name Description Required Default Pattern

loanId

loanId

X

null

transactionId

transactionId

X

null

Body Parameter
Name Description Required Default Pattern

PutChargeTransactionChangesRequest

Section .2.1002

X

Return Type
Content Type
  • application/json

Responses
Table 377. http response codes
Code Message Datatype

200

OK

Section .2.1003

Samples

.1.65. Loans

calculateLoanScheduleOrSubmitLoanApplication

POST /loans

Calculate loan repayment schedule | Submit a new Loan Application

Description

It calculates the loan repayment Schedule Submits a new loan application Mandatory Fields: clientId, productId, principal, loanTermFrequency, loanTermFrequencyType, loanType, numberOfRepayments, repaymentEvery, repaymentFrequencyType, interestRatePerPeriod, amortizationType, interestType, interestCalculationPeriodType, transactionProcessingStrategyId, expectedDisbursementDate, submittedOnDate, loanType Optional Fields: graceOnPrincipalPayment, graceOnInterestPayment, graceOnInterestCharged, linkAccountId, allowPartialPeriodInterestCalcualtion, fixedEmiAmount, maxOutstandingLoanBalance, disbursementData, graceOnArrearsAgeing, createStandingInstructionAtDisbursement (requires linkedAccountId if set to true) Additional Mandatory Fields if interest recalculation is enabled for product and Rest frequency not same as repayment period: recalculationRestFrequencyDate Additional Mandatory Fields if interest recalculation with interest/fee compounding is enabled for product and compounding frequency not same as repayment period: recalculationCompoundingFrequencyDate Additional Mandatory Field if Entity-Datatable Check is enabled for the entity of type loan: datatables

Parameters
Body Parameter
Name Description Required Default Pattern

PostLoansRequest

Section .2.897

X

Query Parameters
Name Description Required Default Pattern

command

command

-

null

Return Type
Content Type
  • application/json

Responses
Table 378. http response codes
Code Message Datatype

200

OK

Section .2.898

Samples
deleteLoanApplication

DELETE /loans/{loanId}

Delete a Loan Application

Description

Note: Only loans in \"Submitted and awaiting approval\" status can be deleted.

Parameters
Path Parameters
Name Description Required Default Pattern

loanId

loanId

X

null

Return Type
Content Type
  • application/json

Responses
Table 379. http response codes
Code Message Datatype

200

OK

Section .2.54

Samples
getGlimRepaymentTemplate

GET /loans/glimAccount/{glimId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

glimId

X

null

Return Type
Content Type
  • application/json

Responses
Table 380. http response codes
Code Message Datatype

0

default response

[String]

Samples
getLoanRepaymentTemplate

GET /loans/repayments/downloadtemplate

Description
Parameters
Query Parameters
Name Description Required Default Pattern

officeId

-

null

dateFormat

-

null

Return Type

-

Content Type
  • application/vnd.ms-excel

Responses
Table 381. http response codes
Code Message Datatype

0

default response

<<>>

Samples
getLoansTemplate

GET /loans/downloadtemplate

Description
Parameters
Query Parameters
Name Description Required Default Pattern

officeId

-

null

staffId

-

null

dateFormat

-

null

Return Type

-

Content Type
  • application/vnd.ms-excel

Responses
Table 382. http response codes
Code Message Datatype

0

default response

<<>>

Samples
glimStateTransitions

POST /loans/glimAccount/{glimId}

Approve GLIM Application | Undo GLIM Application Approval | Reject GLIM Application | Disburse Loan Disburse Loan To Savings Account | Undo Loan Disbursal

Description

Approve GLIM Application: Mandatory Fields: approvedOnDate Optional Fields: approvedLoanAmount and expectedDisbursementDate Approves the GLIM application Undo GLIM Application Approval: Undoes the GLIM Application Approval Reject GLIM Application: Mandatory Fields: rejectedOnDate Allows you to reject the GLIM application Disburse Loan: Mandatory Fields: actualDisbursementDate Optional Fields: transactionAmount and fixedEmiAmount Disburses the Loan Disburse Loan To Savings Account: Mandatory Fields: actualDisbursementDate Optional Fields: transactionAmount and fixedEmiAmount Disburses the loan to Saving Account Undo Loan Disbursal: Undoes the Loan Disbursal

Parameters
Path Parameters
Name Description Required Default Pattern

glimId

X

null

Body Parameter
Name Description Required Default Pattern

PostLoansLoanIdRequest

Section .2.890

X

Query Parameters
Name Description Required Default Pattern

command

-

null

Return Type
Content Type
  • application/json

Responses
Table 383. http response codes
Code Message Datatype

200

OK

Section .2.891

Samples
modifyLoanApplication

PUT /loans/{loanId}

Modify a loan application

Description

Loan application can only be modified when in 'Submitted and pending approval' state. Once the application is approved, the details cannot be changed using this method.

Parameters
Path Parameters
Name Description Required Default Pattern

loanId

loanId

X

null

Body Parameter
Name Description Required Default Pattern

PutLoansLoanIdRequest

Section .2.1078

X

Return Type
Content Type
  • application/json

Responses
Table 384. http response codes
Code Message Datatype

200

OK

Section .2.1079

Samples
postLoanRepaymentTemplate

POST /loans/repayments/uploadtemplate

Description
Parameters
Form Parameters
Name Description Required Default Pattern

dateFormat

[string]

-

null

locale

[string]

-

null

uploadedInputStream

[file]

-

null

Return Type
Content Type
  • /

Responses
Table 385. http response codes
Code Message Datatype

0

default response

[String]

Samples
postLoanTemplate

POST /loans/uploadtemplate

Description
Parameters
Form Parameters
Name Description Required Default Pattern

dateFormat

[string]

-

null

locale

[string]

-

null

uploadedInputStream

[file]

-

null

Return Type
Content Type
  • /

Responses
Table 386. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveAll27

GET /loans

List Loans

Description

The list capability of loans can support pagination and sorting. Example Requests: loans loans?fields=accountNo loans?offset=10&limit=50 loans?orderBy=accountNo&sortOrder=DESC

Parameters
Query Parameters
Name Description Required Default Pattern

sqlSearch

sqlSearch

-

null

externalId

externalId

-

null

offset

offset

-

null

limit

limit

-

null

orderBy

orderBy

-

null

sortOrder

sortOrder

-

null

accountNo

accountNo

-

null

Return Type
Content Type
  • application/json

Responses
Table 387. http response codes
Code Message Datatype

200

OK

Section .2.435

Samples
retrieveApprovalTemplate

GET /loans/{loanId}/template

Description
Parameters
Path Parameters
Name Description Required Default Pattern

loanId

loanId

X

null

Query Parameters
Name Description Required Default Pattern

templateType

templateType

-

null

Return Type
Content Type
  • application/json

Responses
Table 388. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveLoan

GET /loans/{loanId}

Retrieve a Loan

Description

Note: template=true parameter doesn’t apply to this resource.Example Requests: loans/1 loans/1?fields=id,principal,annualInterestRate loans/1?associations=all loans/1?associations=all&exclude=guarantors loans/1?fields=id,principal,annualInterestRate&associations=repaymentSchedule,transactions

Parameters
Path Parameters
Name Description Required Default Pattern

loanId

loanId

X

null

Query Parameters
Name Description Required Default Pattern

staffInSelectedOfficeOnly

staffInSelectedOfficeOnly

-

false

Return Type
Content Type
  • application/json

Responses
Table 389. http response codes
Code Message Datatype

200

OK

Section .2.424

Samples
stateTransitions

POST /loans/{loanId}

Approve Loan Application | Recover Loan Guarantee | Undo Loan Application Approval | Assign a Loan Officer | Unassign a Loan Officer | Reject Loan Application | Applicant Withdraws from Loan Application | Disburse Loan Disburse Loan To Savings Account | Undo Loan Disbursal

Description

Approve Loan Application: Mandatory Fields: approvedOnDate Optional Fields: approvedLoanAmount and expectedDisbursementDate Approves the loan application Recover Loan Guarantee: Recovers the loan guarantee Undo Loan Application Approval: Undoes the Loan Application Approval Assign a Loan Officer: Allows you to assign Loan Officer for existing Loan. Unassign a Loan Officer: Allows you to unassign the Loan Officer. Reject Loan Application: Mandatory Fields: rejectedOnDate Allows you to reject the loan application Applicant Withdraws from Loan Application: Mandatory Fields: withdrawnOnDate Allows the applicant to withdraw the loan application Disburse Loan: Mandatory Fields: actualDisbursementDate Optional Fields: transactionAmount and fixedEmiAmount Disburses the Loan Disburse Loan To Savings Account: Mandatory Fields: actualDisbursementDate Optional Fields: transactionAmount and fixedEmiAmount Disburses the loan to Saving Account Undo Loan Disbursal: Undoes the Loan Disbursal Showing request and response for Assign a Loan Officer

Parameters
Path Parameters
Name Description Required Default Pattern

loanId

loanId

X

null

Body Parameter
Name Description Required Default Pattern

PostLoansLoanIdRequest

Section .2.890

X

Query Parameters
Name Description Required Default Pattern

command

command

-

null

Return Type
Content Type
  • application/json

Responses
Table 390. http response codes
Code Message Datatype

200

OK

Section .2.891

Samples
template10

GET /loans/template

Retrieve Loan Details Template

Description

This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults Allowed description Lists Example Requests: loans/template?templateType=individual&clientId=1 loans/template?templateType=individual&clientId=1&productId=1

Parameters
Query Parameters
Name Description Required Default Pattern

clientId

clientId

-

null

groupId

groupId

-

null

productId

productId

-

null

templateType

templateType

-

null

staffInSelectedOfficeOnly

staffInSelectedOfficeOnly

-

false

activeOnly

activeOnly

-

false

Return Type
Content Type
  • application/json

Responses
Table 391. http response codes
Code Message Datatype

200

OK

Section .2.437

Samples

.1.66. MIFOSXBATCHJOBS

executeJob

POST /jobs/{jobId}

Run a Job

Description

Manually Execute Specific Job.

Parameters
Path Parameters
Name Description Required Default Pattern

jobId

jobId

X

null

Query Parameters
Name Description Required Default Pattern

command

command

-

null

Return Type

-

Responses
Table 392. http response codes
Code Message Datatype

200

POST: jobs/1?command=executeJob

<<>>

Samples
retrieveAll8

GET /jobs

Retrieve Scheduler Jobs

Description

Returns the list of jobs. Example Requests: jobs

Parameters
Return Type
Content Type
  • application/json

Responses
Table 393. http response codes
Code Message Datatype

200

OK

List[Section .2.343]

Samples
retrieveHistory

GET /jobs/{jobId}/runhistory

Retrieve Job Run History

Description

Example Requests: jobs/5/runhistory?offset=0&limit=200

Parameters
Path Parameters
Name Description Required Default Pattern

jobId

jobId

X

null

Query Parameters
Name Description Required Default Pattern

offset

offset

-

null

limit

limit

-

null

orderBy

orderBy

-

null

sortOrder

sortOrder

-

null

Return Type
Content Type
  • application/json

Responses
Table 394. http response codes
Code Message Datatype

200

OK

Section .2.342

Samples
retrieveOne5

GET /jobs/{jobId}

Retrieve a Job

Description

Returns the details of a Job. Example Requests: jobs/5

Parameters
Path Parameters
Name Description Required Default Pattern

jobId

jobId

X

null

Return Type
Content Type
  • application/json

Responses
Table 395. http response codes
Code Message Datatype

200

OK

Section .2.343

Samples
updateJobDetail

PUT /jobs/{jobId}

Update a Job

Description

Updates the details of a job.

Parameters
Path Parameters
Name Description Required Default Pattern

jobId

jobId

X

null

Body Parameter
Name Description Required Default Pattern

PutJobsJobIDRequest

Section .2.1070

X

Return Type

-

Responses
Table 396. http response codes
Code Message Datatype

200

OK

<<>>

Samples

.1.67. MakerCheckerOr4EyeFunctionality

approveMakerCheckerEntry

POST /makercheckers/{auditId}

Approve Maker Checker Entry | Reject Maker Checker Entry

Description
Parameters
Path Parameters
Name Description Required Default Pattern

auditId

auditId

X

null

Query Parameters
Name Description Required Default Pattern

command

command

-

null

Return Type
Content Type
  • application/json

Responses
Table 397. http response codes
Code Message Datatype

200

OK

Section .2.899

Samples
deleteMakerCheckerEntry

DELETE /makercheckers/{auditId}

Delete Maker Checker Entry

Description
Parameters
Path Parameters
Name Description Required Default Pattern

auditId

auditId

X

null

Return Type
Content Type
  • application/json

Responses
Table 398. http response codes
Code Message Datatype

200

OK

Section .2.899

Samples
retrieveAuditSearchTemplate1

GET /makercheckers/searchtemplate

Maker Checker Search Template

Description

This is a convenience resource. It can be useful when building a Checker Inbox UI. \"appUsers\" are data scoped to the office/branch the requestor is associated with. \"actionNames\" and \"entityNames\" returned are those that the requestor has Checker approval permissions for. Example Requests: makercheckers/searchtemplate makercheckers/searchtemplate?fields=entityNames

Parameters
Return Type
Content Type
  • application/json

Responses
Table 399. http response codes
Code Message Datatype

200

OK

Section .2.444

Samples
retrieveCommands

GET /makercheckers

List Maker Checker Entries

Description

Get a list of entries that can be checked by the requestor that match the criteria supplied. Example Requests: makercheckers makercheckers?fields=madeOnDate,maker,processingResult makercheckers?makerDateTimeFrom=2013-03-25 08:00:00&makerDateTimeTo=2013-04-04 18:00:00 makercheckers?officeId=1 makercheckers?officeId=1&includeJson=true

Parameters
Query Parameters
Name Description Required Default Pattern

actionName

actionName

-

null

entityName

entityName

-

null

resourceId

resourceId

-

null

makerId

makerId

-

null

makerDateTimeFrom

makerDateTimeFrom

-

null

makerDateTimeTo

makerDateTimeTo

-

null

officeId

officeId

-

null

groupId

groupId

-

null

clientId

clientId

-

null

loanid

loanid

-

null

savingsAccountId

savingsAccountId

-

null

Return Type
Content Type
  • application/json

Responses
Table 400. http response codes
Code Message Datatype

200

OK

List[Section .2.443]

Samples

.1.68. MappingFinancialActivitiesToAccounts

createGLAccount

POST /financialactivityaccounts

Create a new Financial Activity to Accounts Mapping

Description

Mandatory Fields financialActivityId, glAccountId

Parameters
Body Parameter
Name Description Required Default Pattern

PostFinancialActivityAccountsRequest

Section .2.841

-

Return Type
Content Type
  • application/json

Responses
Table 401. http response codes
Code Message Datatype

200

OK

Section .2.842

Samples
deleteGLAccount

DELETE /financialactivityaccounts/{mappingId}

Delete a Financial Activity to Account Mapping

Description
Parameters
Path Parameters
Name Description Required Default Pattern

mappingId

mappingId

X

null

Return Type
Content Type
  • application/json

Responses
Table 402. http response codes
Code Message Datatype

200

OK

Section .2.42

Samples
retreive

GET /financialactivityaccounts/{mappingId}

Retrieve a Financial Activity to Account Mapping

Description

Example Requests: financialactivityaccounts/1

Parameters
Path Parameters
Name Description Required Default Pattern

mappingId

mappingId

X

null

Return Type
Content Type
  • application/json

Responses
Table 403. http response codes
Code Message Datatype

200

OK

Section .2.230

Samples
retrieveAll

GET /financialactivityaccounts

List Financial Activities to Accounts Mappings

Description

Example Requests: financialactivityaccounts

Parameters
Return Type
Content Type
  • application/json

Responses
Table 404. http response codes
Code Message Datatype

200

OK

List[Section .2.230]

Samples
retrieveTemplate

GET /financialactivityaccounts/template

Description
Parameters
Return Type
Content Type
  • application/json

Responses
Table 405. http response codes
Code Message Datatype

0

default response

[String]

Samples
updateGLAccount

PUT /financialactivityaccounts/{mappingId}

Update a Financial Activity to Account Mapping

Description

the API updates the Ledger account linked to a Financial Activity

Parameters
Path Parameters
Name Description Required Default Pattern

mappingId

mappingId

X

null

Body Parameter
Name Description Required Default Pattern

PostFinancialActivityAccountsRequest

Section .2.841

-

Return Type
Content Type
  • application/json

Responses
Table 406. http response codes
Code Message Datatype

200

OK

Section .2.1036

Samples

.1.69. Meetings

createMeeting

POST /{entityType}/{entityId}/meetings

Description
Parameters
Path Parameters
Name Description Required Default Pattern

entityType

X

null

entityId

X

null

Body Parameter
Name Description Required Default Pattern

body

[string]

-

Return Type
Content Type
  • application/json

Responses
Table 407. http response codes
Code Message Datatype

0

default response

[String]

Samples
deleteMeeting

DELETE /{entityType}/{entityId}/meetings/{meetingId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

entityType

X

null

entityId

X

null

meetingId

X

null

Return Type
Content Type
  • application/json

Responses
Table 408. http response codes
Code Message Datatype

0

default response

[String]

Samples
performMeetingCommands

POST /{entityType}/{entityId}/meetings/{meetingId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

entityType

X

null

entityId

X

null

meetingId

X

null

Body Parameter
Name Description Required Default Pattern

body

[string]

-

Query Parameters
Name Description Required Default Pattern

command

-

null

Return Type
Content Type
  • application/json

Responses
Table 409. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveMeeting

GET /{entityType}/{entityId}/meetings/{meetingId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

meetingId

X

null

entityType

X

null

entityId

X

null

Return Type
Content Type
  • application/json

Responses
Table 410. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveMeetings

GET /{entityType}/{entityId}/meetings

Description
Parameters
Path Parameters
Name Description Required Default Pattern

entityType

X

null

entityId

X

null

Query Parameters
Name Description Required Default Pattern

limit

-

null

Return Type
Content Type
  • application/json

Responses
Table 411. http response codes
Code Message Datatype

0

default response

[String]

Samples
template11

GET /{entityType}/{entityId}/meetings/template

Description
Parameters
Path Parameters
Name Description Required Default Pattern

entityType

X

null

entityId

X

null

Query Parameters
Name Description Required Default Pattern

calendarId

-

null

Return Type
Content Type
  • application/json

Responses
Table 412. http response codes
Code Message Datatype

0

default response

[String]

Samples
updateMeeting

PUT /{entityType}/{entityId}/meetings/{meetingId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

entityType

X

null

entityId

X

null

meetingId

X

null

Body Parameter
Name Description Required Default Pattern

body

[string]

-

Return Type
Content Type
  • application/json

Responses
Table 413. http response codes
Code Message Datatype

0

default response

[String]

Samples

.1.70. MixMapping

retrieveTaxonomyMapping

GET /mixmapping

Description
Parameters
Return Type
Content Type
  • application/json

Responses
Table 414. http response codes
Code Message Datatype

0

default response

[String]

Samples
updateTaxonomyMapping

PUT /mixmapping

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

[string]

-

Return Type
Content Type
  • application/json

Responses
Table 415. http response codes
Code Message Datatype

0

default response

[String]

Samples

.1.71. MixReport

retrieveXBRLReport

GET /mixreport

Description
Parameters
Query Parameters
Name Description Required Default Pattern

startDate

-

null

endDate

-

null

currency

-

null

Return Type
Content Type
  • application/xml

Responses
Table 416. http response codes
Code Message Datatype

0

default response

[String]

Samples

.1.72. MixTaxonomy

retrieveAll14

GET /mixtaxonomy

Description
Parameters
Return Type
Content Type
  • application/json

Responses
Table 417. http response codes
Code Message Datatype

0

default response

[String]

Samples

.1.73. Notes

addNewNote

POST /{resourceType}/{resourceId}/notes

Add a Resource Note

Description

Adds a new note to a supported resource. Example Requests: clients/1/notes groups/1/notes

Parameters
Path Parameters
Name Description Required Default Pattern

resourceType

resourceType

X

null

resourceId

resourceId

X

null

Body Parameter
Name Description Required Default Pattern

PostResourceTypeResourceIdNotesRequest

Section .2.929

X

Return Type
Content Type
  • application/json

Responses
Table 418. http response codes
Code Message Datatype

200

OK

Section .2.930

Samples
deleteNote

DELETE /{resourceType}/{resourceId}/notes/{noteId}

Delete a Resource Note

Description

Deletes a Resource Note

Parameters
Path Parameters
Name Description Required Default Pattern

resourceType

resourceType

X

null

resourceId

resourceId

X

null

noteId

noteId

X

null

Return Type
Content Type
  • application/json

Responses
Table 419. http response codes
Code Message Datatype

200

OK

Section .2.62

Samples
retrieveNote

GET /{resourceType}/{resourceId}/notes/{noteId}

Retrieve a Resource Note

Description

Retrieves a Resource Note Example Requests: clients/1/notes/76 groups/1/notes/20 clients/1/notes/76?fields=note,createdOn,createdByUsername groups/1/notes/20?fields=note,createdOn,createdByUsername

Parameters
Path Parameters
Name Description Required Default Pattern

resourceType

resourceType

X

null

resourceId

resourceId

X

null

noteId

noteId

X

null

Return Type
Content Type
  • application/json

Responses
Table 420. http response codes
Code Message Datatype

200

OK

Section .2.546

Samples
retrieveNotesByResource

GET /{resourceType}/{resourceId}/notes

Retrieve a Resource’s description

Description

Retrieves a Resource’s Notes Note: Notes are returned in descending createOn order. Example Requests: clients/2/notes groups/2/notes?fields=note,createdOn,createdByUsername

Parameters
Path Parameters
Name Description Required Default Pattern

resourceType

resourceType

X

null

resourceId

resourceId

X

null

Return Type
Content Type
  • application/json

Responses
Table 421. http response codes
Code Message Datatype

200

OK

List[Section .2.547]

Samples
updateNote

PUT /{resourceType}/{resourceId}/notes/{noteId}

Update a Resource Note

Description

Updates a Resource Note

Parameters
Path Parameters
Name Description Required Default Pattern

resourceType

resourceType

X

null

resourceId

resourceId

X

null

noteId

noteId

X

null

Body Parameter
Name Description Required Default Pattern

PutResourceTypeResourceIdNotesNoteIdRequest

Section .2.1109

X

Return Type
Content Type
  • application/json

Responses
Table 422. http response codes
Code Message Datatype

200

OK

Section .2.1110

Samples

.1.74. Notification

getAllNotifications

GET /notifications

Description
Parameters
Query Parameters
Name Description Required Default Pattern

orderBy

-

null

limit

-

null

offset

-

null

sortOrder

-

null

isRead

-

null

Return Type
Content Type
  • application/json

Responses
Table 423. http response codes
Code Message Datatype

0

default response

[String]

Samples
update5

PUT /notifications

Description
Parameters
Return Type

-

Content Type
  • application/json

Responses
Table 424. http response codes
Code Message Datatype

0

default response

<<>>

Samples

.1.75. Offices

createOffice

POST /offices

Create an Office

Description

Mandatory Fields name, openingDate, parentId

Parameters
Body Parameter
Name Description Required Default Pattern

PostOfficesRequest

Section .2.902

X

Return Type
Content Type
  • application/json

Responses
Table 425. http response codes
Code Message Datatype

200

OK

Section .2.903

Samples
getOfficeTemplate

GET /offices/downloadtemplate

Description
Parameters
Query Parameters
Name Description Required Default Pattern

dateFormat

-

null

Return Type

-

Content Type
  • application/vnd.ms-excel

Responses
Table 426. http response codes
Code Message Datatype

0

default response

<<>>

Samples
postOfficeTemplate

POST /offices/uploadtemplate

Description
Parameters
Form Parameters
Name Description Required Default Pattern

dateFormat

[string]

-

null

locale

[string]

-

null

uploadedInputStream

[file]

-

null

Return Type
Content Type
  • /

Responses
Table 427. http response codes
Code Message Datatype

0

default response

[String]

Samples
retreiveOffice

GET /offices/{officeId}

Retrieve an Office

Description

Example Requests: offices/1 offices/1?template=true offices/1?fields=id,name,parentName

Parameters
Path Parameters
Name Description Required Default Pattern

officeId

officeId

X

null

Return Type
Content Type
  • application/json

Responses
Table 428. http response codes
Code Message Datatype

200

OK

Section .2.446

Samples
retrieveOfficeTemplate1

GET /offices/template

Retrieve Office Details Template

Description

This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults Allowed description Lists Example Request: offices/template

Parameters
Return Type
Content Type
  • application/json

Responses
Table 429. http response codes
Code Message Datatype

200

OK

Section .2.447

Samples
retrieveOffices

GET /offices

List Offices

Description

Example Requests: offices offices?fields=id,name,openingDate

Parameters
Query Parameters
Name Description Required Default Pattern

includeAllOffices

includeAllOffices

-

false

orderBy

orderBy

-

null

sortOrder

sortOrder

-

null

Return Type
Content Type
  • application/json

Responses
Table 430. http response codes
Code Message Datatype

200

OK

List[Section .2.446]

Samples
updateOffice

PUT /offices/{officeId}

Update Office

Description
Parameters
Path Parameters
Name Description Required Default Pattern

officeId

officeId

X

null

Body Parameter
Name Description Required Default Pattern

PutOfficesOfficeIdRequest

Section .2.1082

X

Return Type
Content Type
  • application/json

Responses
Table 431. http response codes
Code Message Datatype

200

OK

Section .2.1083

Samples

.1.76. PasswordPreferences

retrieve1

GET /passwordpreferences

Description
Parameters
Return Type
Content Type
  • application/json

Responses
Table 432. http response codes
Code Message Datatype

200

OK

Section .2.449

Samples
template21

GET /passwordpreferences/template

List Application Password validation policies

Description

ARGUMENTS Example Requests: passwordpreferences

Parameters
Return Type
Content Type
  • application/json

Responses
Table 433. http response codes
Code Message Datatype

200

OK

List[Section .2.449]

Samples
update23

PUT /passwordpreferences

Update password preferences

Description
Parameters
Body Parameter
Name Description Required Default Pattern

PutPasswordPreferencesTemplateRequest

Section .2.1085

X

Return Type

-

Responses
Table 434. http response codes
Code Message Datatype

200

OK

<<>>

Samples

.1.77. PaymentType

createPaymentType

POST /paymenttypes

Create a Payment Type

Description

Creates a new Payment type Mandatory Fields: name Optional Fields: Description, isCashPayment,Position

Parameters
Body Parameter
Name Description Required Default Pattern

PostPaymentTypesRequest

Section .2.904

X

Return Type
Content Type
  • application/json

Responses
Table 435. http response codes
Code Message Datatype

200

OK

Section .2.905

Samples
deleteCode1

DELETE /paymenttypes/{paymentTypeId}

Delete a Payment Type

Description

Deletes payment type

Parameters
Path Parameters
Name Description Required Default Pattern

paymentTypeId

paymentTypeId

X

null

Return Type
Content Type
  • application/json

Responses
Table 436. http response codes
Code Message Datatype

200

OK

Section .2.55

Samples
getAllPaymentTypes

GET /paymenttypes

Retrieve all Payment Types

Description

Retrieve list of payment types

Parameters
Return Type
Content Type
  • application/json

Responses
Table 437. http response codes
Code Message Datatype

200

OK

List[Section .2.451]

Samples
retrieveOnePaymentType

GET /paymenttypes/{paymentTypeId}

Retrieve a Payment Type

Description

Retrieves a payment type

Parameters
Path Parameters
Name Description Required Default Pattern

paymentTypeId

paymentTypeId

X

null

Return Type
Content Type
  • application/json

Responses
Table 438. http response codes
Code Message Datatype

200

OK

Section .2.450

Samples
updatePaymentType

PUT /paymenttypes/{paymentTypeId}

Update a Payment Type

Description

Updates a Payment Type

Parameters
Path Parameters
Name Description Required Default Pattern

paymentTypeId

paymentTypeId

X

null

Body Parameter
Name Description Required Default Pattern

PutPaymentTypesPaymentTypeIdRequest

Section .2.1086

X

Return Type
Content Type
  • application/json

Responses
Table 439. http response codes
Code Message Datatype

200

OK

Section .2.1087

Samples

.1.78. PeriodicAccrualAccounting

executePeriodicAccrualAccounting

POST /runaccruals

Executes Periodic Accrual Accounting

Description

Mandatory Fields tillDate

Parameters
Body Parameter
Name Description Required Default Pattern

PostRunaccrualsRequest

Section .2.935

X

Return Type

-

Responses
Table 440. http response codes
Code Message Datatype

200

OK

<<>>

Samples

.1.79. Permissions

retrieveAllPermissions

GET /permissions

List Application Permissions

Description

ARGUMENTS makerCheckerableoptional, Values are true, false. Default is false. If makerCheckerable=false or not supplied then a list of application permissions is returned. The \"selected\" attribute is always true in this case. If makerCheckerable=true then the \"selected\" attribute shows whether the permission is enabled for Maker Check functionality. Note: Each Apache Fineract transaction is associated with a permission. Example Requests: permissions permissions?makerCheckerable=true permissions?fields=grouping,code

Parameters
Return Type
Content Type
  • application/json

Responses
Table 441. http response codes
Code Message Datatype

200

OK

List[Section .2.452]

Samples
updatePermissionsDetails

PUT /permissions

Enable/Disable Permissions for Maker Checker

Description
Parameters
Body Parameter
Name Description Required Default Pattern

PutPermissionsRequest

Section .2.1088

X

Return Type
Content Type
  • application/json

Responses
Table 442. http response codes
Code Message Datatype

200

OK

Section .2.19

Samples

.1.80. Pocket

handleCommands7

POST /self/pockets

Link/delink accounts to/from pocket

Description

Pockets behave as favourites. An user can link his/her Loan, Savings and Share accounts to pocket for faster access. In a similar way linked accounts can be delinked from the pocket. Example Requests: self/pockets?command=linkAccounts self/pockets?command=delinkAccounts

Parameters
Body Parameter
Name Description Required Default Pattern

body

[string]

-

Query Parameters
Name Description Required Default Pattern

command

command

-

null

Return Type
Content Type
  • application/json

Responses
Table 443. http response codes
Code Message Datatype

200

OK

Section .2.880

Samples
retrieveAll37

GET /self/pockets

Retrieve accounts linked to pocket

Description

All linked loan Example Requests: self/pockets

Parameters
Return Type
Content Type
  • application/json

Responses
Table 444. http response codes
Code Message Datatype

200

OK

Section .2.123

Samples

.1.81. PovertyLine

retrieveAll12

GET /povertyLine/{ppiName}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

ppiName

X

null

Return Type
Content Type
  • application/json

Responses
Table 445. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveAll13

GET /povertyLine/{ppiName}/{likelihoodId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

ppiName

X

null

likelihoodId

X

null

Return Type
Content Type
  • application/json

Responses
Table 446. http response codes
Code Message Datatype

0

default response

[String]

Samples

.1.82. ProductMix

createProductMix

POST /loanproducts/{productId}/productmix

Description
Parameters
Path Parameters
Name Description Required Default Pattern

productId

X

null

Body Parameter
Name Description Required Default Pattern

body

[string]

-

Return Type
Content Type
  • application/json

Responses
Table 447. http response codes
Code Message Datatype

0

default response

[String]

Samples
deleteProductMix

DELETE /loanproducts/{productId}/productmix

Description
Parameters
Path Parameters
Name Description Required Default Pattern

productId

X

null

Return Type
Content Type
  • application/json

Responses
Table 448. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveTemplate11

GET /loanproducts/{productId}/productmix

Description
Parameters
Path Parameters
Name Description Required Default Pattern

productId

X

null

Return Type
Content Type
  • application/json

Responses
Table 449. http response codes
Code Message Datatype

0

default response

[String]

Samples
updateProductMix

PUT /loanproducts/{productId}/productmix

Description
Parameters
Path Parameters
Name Description Required Default Pattern

productId

X

null

Body Parameter
Name Description Required Default Pattern

body

[string]

-

Return Type
Content Type
  • application/json

Responses
Table 450. http response codes
Code Message Datatype

0

default response

[String]

Samples

.1.83. Products

createProduct

POST /products/{type}

Create a Share Product

Description

Creates a Share Product Mandatory Fields: name, shortName, description, currencyCode, digitsAfterDecimal,inMultiplesOf, locale, totalShares, unitPrice, nominalShares,allowDividendCalculationForInactiveClients,accountingRule Mandatory Fields for Cash based accounting (accountingRule = 2): shareReferenceId, shareSuspenseId, shareEquityId, incomeFromFeeAccountId Optional Fields: sharesIssued, minimumShares, maximumShares, minimumActivePeriodForDividends, minimumactiveperiodFrequencyType, lockinPeriodFrequency, lockinPeriodFrequencyType, marketPricePeriods, chargesSelected

Parameters
Path Parameters
Name Description Required Default Pattern

type

type

X

null

Body Parameter
Name Description Required Default Pattern

PostProductsTypeRequest

Section .2.908

X

Return Type
Content Type
  • application/json

Responses
Table 451. http response codes
Code Message Datatype

200

OK

Section .2.909

Samples
handleCommands3

POST /products/{type}/{productId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

type

type

X

null

productId

productId

X

null

Query Parameters
Name Description Required Default Pattern

command

command

-

null

Return Type
Content Type
  • application/json

Responses
Table 452. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveAllProducts

GET /products/{type}

List Share Products

Description

Lists Share Products Mandatory Fields: limit, offset Example Requests: shareproducts

Parameters
Path Parameters
Name Description Required Default Pattern

type

type

X

null

Query Parameters
Name Description Required Default Pattern

offset

offset

-

null

limit

limit

-

null

Return Type
Content Type
  • application/json

Responses
Table 453. http response codes
Code Message Datatype

200

OK

Section .2.475

Samples
retrieveProduct

GET /products/{type}/{productId}

Retrieve a Share Product

Description

Retrieves a Share Product Example Requests: products/share/1 products/share/1?template=true

Parameters
Path Parameters
Name Description Required Default Pattern

productId

productId

X

null

type

type

X

null

Return Type
Content Type
  • application/json

Responses
Table 454. http response codes
Code Message Datatype

200

OK

Section .2.474

Samples
retrieveTemplate12

GET /products/{type}/template

Description
Parameters
Path Parameters
Name Description Required Default Pattern

type

type

X

null

Return Type
Content Type
  • application/json

Responses
Table 455. http response codes
Code Message Datatype

0

default response

[String]

Samples
updateProduct

PUT /products/{type}/{productId}

Update a Share Product

Description

Updates a Share Product

Parameters
Path Parameters
Name Description Required Default Pattern

type

type

X

null

productId

productId

X

null

Body Parameter
Name Description Required Default Pattern

PutProductsTypeProductIdRequest

Section .2.1090

X

Return Type
Content Type
  • application/json

Responses
Table 456. http response codes
Code Message Datatype

200

OK

Section .2.1091

Samples

.1.84. ProvisioningCategory

createProvisioningCategory

POST /provisioningcategory

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

[string]

-

Return Type
Content Type
  • application/json

Responses
Table 457. http response codes
Code Message Datatype

0

default response

[String]

Samples
deleteProvisioningCategory

DELETE /provisioningcategory/{categoryId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

categoryId

X

null

Return Type
Content Type
  • application/json

Responses
Table 458. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveAll15

GET /provisioningcategory

Description
Parameters
Return Type
Content Type
  • application/json

Responses
Table 459. http response codes
Code Message Datatype

0

default response

[String]

Samples
updateProvisioningCategory

PUT /provisioningcategory/{categoryId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

categoryId

X

null

Body Parameter
Name Description Required Default Pattern

body

[string]

-

Return Type
Content Type
  • application/json

Responses
Table 460. http response codes
Code Message Datatype

0

default response

[String]

Samples

.1.85. ProvisioningCriteria

createProvisioningCriteria

POST /provisioningcriteria

Create a new Provisioning Criteria

Description

Creates a new Provisioning Criteria Mandatory Fields: criteriaName provisioningcriteria Optional Fields: loanProducts

Parameters
Body Parameter
Name Description Required Default Pattern

PostProvisioningCriteriaRequest

Section .2.910

X

Return Type
Content Type
  • application/json

Responses
Table 461. http response codes
Code Message Datatype

200

OK

Section .2.911

Samples
deleteProvisioningCriteria

DELETE /provisioningcriteria/{criteriaId}

Deletes Provisioning Criteria

Description

Deletes Provisioning Criteria

Parameters
Path Parameters
Name Description Required Default Pattern

criteriaId

criteriaId

X

null

Return Type
Content Type
  • application/json

Responses
Table 462. http response codes
Code Message Datatype

200

OK

Section .2.57

Samples
retrieveAllProvisioningCriterias

GET /provisioningcriteria

Retrieves all created Provisioning Criterias

Description

Retrieves all created Provisioning Criterias

Parameters
Return Type
Content Type
  • application/json

Responses
Table 463. http response codes
Code Message Datatype

200

OK

List[Section .2.477]

Samples
retrieveProvisioningCriteria

GET /provisioningcriteria/{criteriaId}

Retrieves a Provisioning Criteria

Description

Retrieves a Provisioning Criteria

Parameters
Path Parameters
Name Description Required Default Pattern

criteriaId

criteriaId

X

null

Return Type
Content Type
  • application/json

Responses
Table 464. http response codes
Code Message Datatype

200

OK

Section .2.476

Samples
retrieveTemplate3

GET /provisioningcriteria/template

Description
Parameters
Return Type
Content Type
  • application/json

Responses
Table 465. http response codes
Code Message Datatype

0

default response

[String]

Samples
updateProvisioningCriteria

PUT /provisioningcriteria/{criteriaId}

Updates a new Provisioning Criteria

Description

Updates a new Provisioning Criteria Optional Fields criteriaName, loanProducts, provisioningcriteria

Parameters
Path Parameters
Name Description Required Default Pattern

criteriaId

criteriaId

X

null

Body Parameter
Name Description Required Default Pattern

PutProvisioningCriteriaRequest

Section .2.1092

X

Return Type
Content Type
  • application/json

Responses
Table 466. http response codes
Code Message Datatype

200

OK

Section .2.1093

Samples

.1.86. ProvisioningEntries

createProvisioningEntries

POST /provisioningentries

Create new Provisioning Entries

Description

Creates a new Provisioning Entries Mandatory Fields date dateFormat locale Optional Fields createjournalentries

Parameters
Body Parameter
Name Description Required Default Pattern

PostProvisioningEntriesRequest

Section .2.912

-

Return Type
Content Type
  • application/json

Responses
Table 467. http response codes
Code Message Datatype

200

OK

Section .2.913

Samples
modifyProvisioningEntry

POST /provisioningentries/{entryId}

Recreates Provisioning Entry

Description

Recreates Provisioning Entry | createjournalentry.

Parameters
Path Parameters
Name Description Required Default Pattern

entryId

entryId

X

null

Body Parameter
Name Description Required Default Pattern

PutProvisioningEntriesRequest

Section .2.1095

-

Query Parameters
Name Description Required Default Pattern

command

command=createjournalentry command=recreateprovisioningentry

-

null

Return Type
Content Type
  • application/json

Responses
Table 468. http response codes
Code Message Datatype

200

OK

Section .2.1096

Samples
retrieveAllProvisioningEntries

GET /provisioningentries

List all Provisioning Entries

Description
Parameters
Query Parameters
Name Description Required Default Pattern

offset

offset

-

null

limit

limit

-

null

Return Type
Content Type
  • application/json

Responses
Table 469. http response codes
Code Message Datatype

200

OK

List[Section .2.986]

Samples
retrieveProviioningEntries

GET /provisioningentries/entries

Description
Parameters
Query Parameters
Name Description Required Default Pattern

entryId

-

null

offset

-

null

limit

-

null

officeId

-

null

productId

-

null

categoryId

-

null

Return Type
Content Type
  • application/json

Responses
Table 470. http response codes
Code Message Datatype

200

OK

Section .2.765

Samples
retrieveProvisioningEntry

GET /provisioningentries/{entryId}

Retrieves a Provisioning Entry

Description

Returns the details of a generated Provisioning Entry.

Parameters
Path Parameters
Name Description Required Default Pattern

entryId

entryId

X

null

Return Type
Content Type
  • application/json

Responses
Table 471. http response codes
Code Message Datatype

200

OK

Section .2.986

Samples

.1.87. Rate

createRate

POST /rates

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

[string]

-

Return Type
Content Type
  • application/json

Responses
Table 472. http response codes
Code Message Datatype

0

default response

[String]

Samples
getAllRates

GET /rates

Description
Parameters
Return Type
Content Type
  • application/json

Responses
Table 473. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveRate

GET /rates/{rateId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

rateId

X

null

Return Type
Content Type
  • application/json

Responses
Table 474. http response codes
Code Message Datatype

0

default response

[String]

Samples
updateRate

PUT /rates/{rateId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

rateId

X

null

Body Parameter
Name Description Required Default Pattern

body

[string]

-

Return Type
Content Type
  • application/json

Responses
Table 475. http response codes
Code Message Datatype

0

default response

[String]

Samples

.1.88. RecurringDepositAccount

accountClosureTemplate1

GET /recurringdepositaccounts/{accountId}/template

Description
Parameters
Path Parameters
Name Description Required Default Pattern

accountId

accountId

X

null

Query Parameters
Name Description Required Default Pattern

command

command

-

null

Return Type
Content Type
  • application/json

Responses
Table 476. http response codes
Code Message Datatype

0

default response

[String]

Samples
delete16

DELETE /recurringdepositaccounts/{accountId}

Delete a recurring deposit application

Description

At present we support hard delete of recurring deposit application so long as its in 'Submitted and pending approval' state. One the application is moves past this state, it is not possible to do a 'hard' delete of the application or the account. An API endpoint will be added to close/de-activate the recurring deposit account.

Parameters
Path Parameters
Name Description Required Default Pattern

accountId

accountId

X

null

Return Type
Content Type
  • application/json

Responses
Table 477. http response codes
Code Message Datatype

200

OK

Section .2.58

Samples
getRecurringDepositTemplate

GET /recurringdepositaccounts/downloadtemplate

Description
Parameters
Query Parameters
Name Description Required Default Pattern

officeId

-

null

staffId

-

null

dateFormat

-

null

Return Type

-

Content Type
  • application/vnd.ms-excel

Responses
Table 478. http response codes
Code Message Datatype

0

default response

<<>>

Samples
getRecurringDepositTransactionTemplate

GET /recurringdepositaccounts/transactions/downloadtemplate

Description
Parameters
Query Parameters
Name Description Required Default Pattern

officeId

-

null

dateFormat

-

null

Return Type

-

Content Type
  • application/vnd.ms-excel

Responses
Table 479. http response codes
Code Message Datatype

0

default response

<<>>

Samples
handleCommands5

POST /recurringdepositaccounts/{accountId}

Approve recurring deposit application | Undo approval recurring deposit application | Reject recurring deposit application | Withdraw recurring deposit application | Activate a recurring deposit account | Update the recommended deposit amount for a recurring deposit account | Close a recurring deposit account | Premature Close a recurring deposit account | Calculate Premature amount on Recurring deposit account | Calculate Interest on recurring Deposit Account | Post Interest on recurring Deposit Account

Description

Approve recurring deposit application: Approves recurring deposit application so long as its in 'Submitted and pending approval' state. Undo approval recurring deposit application: Will move 'approved' recurring deposit application back to 'Submitted and pending approval' state. Reject recurring deposit application Rejects recurring deposit application so long as its in 'Submitted and pending approval' state. Withdraw recurring deposit application: Used when an applicant withdraws from the recurring deposit application. It must be in 'Submitted and pending approval' state. Activate a recurring deposit account: Results in an approved recurring deposit application being converted into an 'active' recurring deposit account. Update the recommended deposit amount for a recurring deposit account: Updates the recommended deposit amount for a RD account as on the effective date. Close a recurring deposit account Results in a Matured recurring deposit account being converted into a 'closed' recurring deposit account. On account close allowed actions are.Premature Close a recurring deposit account: Results in an Active recurring deposit account being converted into a 'Premature Closed' recurring deposit account with options to withdraw prematured amount. (premature amount is calculated using interest rate chart applicable along with penal interest if any.) On account premature closure allowed actions are. Calculate Premature amount on Recurring deposit account: Calculate premature amount on recurring deposit till premature close date. Premature amount is calculated based on interest chart and penal interest applicable if any. Calculate Interest on recurring Deposit Account: Calculates interest earned on a recurring deposit account based on todays date. It does not attempt to post or credit the interest on the account. That is responsibility of the Post Interest API that will likely be called by overnight process. Post Interest on recurring Deposit Account: Calculates and Posts interest earned on a recurring deposit account based on todays date and whether an interest posting or crediting event is due. Showing request/response for 'Post Interest on recurring Deposit Account'

Parameters
Path Parameters
Name Description Required Default Pattern

accountId

accountId

X

null

Body Parameter
Name Description Required Default Pattern

body

[object]

X

Query Parameters
Name Description Required Default Pattern

command

command

-

null

Return Type
Content Type
  • application/json

Responses
Table 480. http response codes
Code Message Datatype

200

OK

Section .2.915

Samples
postRecurringDepositTemplate

POST /recurringdepositaccounts/uploadtemplate

Description
Parameters
Form Parameters
Name Description Required Default Pattern

dateFormat

[string]

-

null

locale

[string]

-

null

uploadedInputStream

[file]

-

null

Return Type
Content Type
  • /

Responses
Table 481. http response codes
Code Message Datatype

0

default response

[String]

Samples
postRecurringDepositTransactionsTemplate

POST /recurringdepositaccounts/transactions/uploadtemplate

Description
Parameters
Form Parameters
Name Description Required Default Pattern

dateFormat

[string]

-

null

locale

[string]

-

null

uploadedInputStream

[file]

-

null

Return Type
Content Type
  • /

Responses
Table 482. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveAll31

GET /recurringdepositaccounts

List Recurring deposit applications/accounts

Description

Lists Recurring deposit applications/accounts Example Requests: recurringdepositaccounts recurringdepositaccounts?fields=name

Parameters
Query Parameters
Name Description Required Default Pattern

paged

paged

-

null

offset

offset

-

null

limit

limit

-

null

orderBy

orderBy

-

null

sortOrder

sortOrder

-

null

Return Type
Content Type
  • application/json

Responses
Table 483. http response codes
Code Message Datatype

200

OK

List[Section .2.500]

Samples
retrieveOne21

GET /recurringdepositaccounts/{accountId}

Retrieve a recurring deposit application/account

Description

Retrieves a recurring deposit application/account Example Requests : recurringdepositaccounts/1 recurringdepositaccounts/1?associations=all

Parameters
Path Parameters
Name Description Required Default Pattern

accountId

accountId

X

null

Query Parameters
Name Description Required Default Pattern

staffInSelectedOfficeOnly

staffInSelectedOfficeOnly

-

false

chargeStatus

chargeStatus

-

all

Return Type
Content Type
  • application/json

Responses
Table 484. http response codes
Code Message Datatype

200

OK

Section .2.485

Samples
submitApplication1

POST /recurringdepositaccounts

Submit new recurring deposit application

Description

Submits new recurring deposit application Mandatory Fields: clientId or groupId, productId, submittedOnDate, depositAmount, depositPeriod, depositPeriodFrequencyId Optional Fields: accountNo, externalId, fieldOfficerId,linkAccountId(if provided initial deposit amount will be collected from this account),transferInterestToSavings(By enabling this flag all interest postings will be transferred to linked saving account ) Inherited from Product (if not provided): interestCompoundingPeriodType, interestCalculationType, interestCalculationDaysInYearType, lockinPeriodFrequency, lockinPeriodFrequencyType, preClosurePenalApplicable, preClosurePenalInterest, preClosurePenalInterestOnTypeId, charts, withHoldTax

Parameters
Body Parameter
Name Description Required Default Pattern

PostRecurringDepositAccountsRequest

Section .2.919

X

Return Type
Content Type
  • application/json

Responses
Table 485. http response codes
Code Message Datatype

200

OK

Section .2.920

Samples
template13

GET /recurringdepositaccounts/template

Retrieve recurring Deposit Account Template

Description

This is a convenience resource. It can be useful when building maintenance user interface screens for recurring deposit applications. The template data returned consists of any or all of: Field Defaults Allowed Value Lists Example Requests: recurringdepositaccounts/template?clientId=1 recurringdepositaccounts/template?clientId=1&productId=1

Parameters
Query Parameters
Name Description Required Default Pattern

clientId

clientId

-

null

groupId

groupId

-

null

productId

productId

-

null

staffInSelectedOfficeOnly

staffInSelectedOfficeOnly

-

false

Return Type
Content Type
  • application/json

Responses
Table 486. http response codes
Code Message Datatype

200

OK

Section .2.503

Samples
update17

PUT /recurringdepositaccounts/{accountId}

Modify a recurring deposit application

Description

Recurring deposit application can only be modified when in 'Submitted and pending approval' state. Once the application is approved, the details cannot be changed using this method. Specific api endpoints will be created to allow change of interest detail such as rate, compounding period, posting period etc

Parameters
Path Parameters
Name Description Required Default Pattern

accountId

accountId

X

null

Body Parameter
Name Description Required Default Pattern

PutRecurringDepositAccountsAccountIdRequest

Section .2.1097

X

Return Type
Content Type
  • application/json

Responses
Table 487. http response codes
Code Message Datatype

200

OK

Section .2.1098

Samples

.1.89. RecurringDepositAccountTransactions

handleTransactionCommands

POST /recurringdepositaccounts/{recurringDepositAccountId}/transactions/{transactionId}

Adjust Transaction | Undo transaction

Description

Adjust Transaction: This command modifies the given transaction. Undo transaction: This command reverses the given transaction. Showing request/response for 'Adjust Transaction'

Parameters
Path Parameters
Name Description Required Default Pattern

recurringDepositAccountId

recurringDepositAccountId

X

null

transactionId

transactionId

X

null

Body Parameter
Name Description Required Default Pattern

PostRecurringDepositAccountsRecurringDepositAccountIdTransactionsRequest

Section .2.916

X

Query Parameters
Name Description Required Default Pattern

command

command

-

null

Return Type
Content Type
  • application/json

Responses
Table 488. http response codes
Code Message Datatype

200

OK

Section .2.918

Samples
retrieveOne20

GET /recurringdepositaccounts/{recurringDepositAccountId}/transactions/{transactionId}

Retrieve Recurring Deposit Account Transaction

Description

Retrieves Recurring Deposit Account Transaction Example Requests: recurringdepositaccounts/1/transactions/1

Parameters
Path Parameters
Name Description Required Default Pattern

recurringDepositAccountId

recurringDepositAccountId

X

null

transactionId

transactionId

X

null

Return Type
Content Type
  • application/json

Responses
Table 489. http response codes
Code Message Datatype

200

OK

Section .2.498

Samples
retrieveTemplate15

GET /recurringdepositaccounts/{recurringDepositAccountId}/transactions/template

Retrieve Recurring Deposit Account Transaction Template

Description

This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults Allowed Value Lists Example Requests: recurringdepositaccounts/1/transactions/template?command=deposit recurringdepositaccounts/1/transactions/template?command=withdrawal

Parameters
Path Parameters
Name Description Required Default Pattern

recurringDepositAccountId

recurringDepositAccountId

X

null

Query Parameters
Name Description Required Default Pattern

command

command

-

null

Return Type
Content Type
  • application/json

Responses
Table 490. http response codes
Code Message Datatype

200

OK

Section .2.497

Samples
transaction1

POST /recurringdepositaccounts/{recurringDepositAccountId}/transactions

Deposit Transaction | Withdrawal Transaction

Description

Deposit Transaction: Used for a deposit transaction Withdrawal Transaction: Used for a Withdrawal Transaction Showing request/response for Deposit Transaction

Parameters
Path Parameters
Name Description Required Default Pattern

recurringDepositAccountId

recurringDepositAccountId

X

null

Body Parameter
Name Description Required Default Pattern

PostRecurringDepositAccountsRecurringDepositAccountIdTransactionsRequest

Section .2.916

X

Query Parameters
Name Description Required Default Pattern

command

command

-

null

Return Type
Content Type
  • application/json

Responses
Table 491. http response codes
Code Message Datatype

200

OK

Section .2.917

Samples

.1.90. RecurringDepositProduct

create12

POST /recurringdepositproducts

Create a Recurring Deposit Product

Description

Creates a Recurring Deposit Product Mandatory Fields: name, shortName, description, currencyCode, digitsAfterDecimal,inMultiplesOf, interestCompoundingPeriodType, interestCalculationType, interestCalculationDaysInYearType, minDepositTerm, minDepositTermTypeId, recurringDepositFrequency, recurringDepositFrequencyTypeId, accountingRule, depositAmount Mandatory Fields for Cash based accounting (accountingRule = 2): savingsReferenceAccountId, savingsControlAccountId, interestOnSavingsAccountId, incomeFromFeeAccountId, transfersInSuspenseAccountId, incomeFromPenaltyAccountId Optional Fields: lockinPeriodFrequency, lockinPeriodFrequencyType, maxDepositTerm, maxDepositTermTypeId, inMultiplesOfDepositTerm, inMultiplesOfDepositTermTypeId, preClosurePenalApplicable, preClosurePenalInterest, preClosurePenalInterestOnTypeId, feeToIncomeAccountMappings, penaltyToIncomeAccountMappings, charges, charts, minDepositAmount, maxDepositAmount, withHoldTax, taxGroupId

Parameters
Body Parameter
Name Description Required Default Pattern

PostRecurringDepositProductsRequest

Section .2.923

X

Return Type
Content Type
  • application/json

Responses
Table 492. http response codes
Code Message Datatype

200

OK

Section .2.924

Samples
delete17

DELETE /recurringdepositproducts/{productId}

Delete a Recurring Deposit Product

Description

Deletes a Recurring Deposit Product

Parameters
Path Parameters
Name Description Required Default Pattern

productId

productId

X

null

Return Type
Content Type
  • application/json

Responses
Table 493. http response codes
Code Message Datatype

200

OK

Section .2.59

Samples
retrieveAll32

GET /recurringdepositproducts

List Recuring Deposit Products

Description

Lists Recuring Deposit Products Example Requests: recurringdepositproducts recurringdepositproducts?fields=name

Parameters
Return Type
Content Type
  • application/json

Responses
Table 494. http response codes
Code Message Datatype

200

OK

List[Section .2.535]

Samples
retrieveOne22

GET /recurringdepositproducts/{productId}

Retrieve a Recurring Deposit Product

Description

Retrieves a Recurring Deposit Product Example Requests: recurringdepositproducts/1 recurringdepositproducts/1?template=true recurringdepositproducts/1?fields=name,description

Parameters
Path Parameters
Name Description Required Default Pattern

productId

productId

X

null

Return Type
Content Type
  • application/json

Responses
Table 495. http response codes
Code Message Datatype

200

OK

Section .2.530

Samples
retrieveTemplate16

GET /recurringdepositproducts/template

Description
Parameters
Return Type
Content Type
  • application/json

Responses
Table 496. http response codes
Code Message Datatype

0

default response

[String]

Samples
update18

PUT /recurringdepositproducts/{productId}

Update a Recurring Deposit Product

Description

Updates a Recurring Deposit Product

Parameters
Path Parameters
Name Description Required Default Pattern

productId

productId

X

null

Body Parameter
Name Description Required Default Pattern

PutRecurringDepositProductsRequest

Section .2.1101

X

Return Type
Content Type
  • application/json

Responses
Table 497. http response codes
Code Message Datatype

200

OK

Section .2.1102

Samples

.1.91. RepaymentWithPostDatedChecks

deletePostDatedCheck

DELETE /loans/{loanId}/postdatedchecks/{postDatedCheckId}

Delete Post Dated Check

Description

Delete Post Dated Check

Parameters
Path Parameters
Name Description Required Default Pattern

postDatedCheckId

postDatedCheckId

X

null

loanId

loanId

X

null

Return Type

array[Section .2.56]

Content Type
  • application/json

Responses
Table 498. http response codes
Code Message Datatype

200

OK

List[Section .2.56]

Samples
getPostDatedCheck

GET /loans/{loanId}/postdatedchecks/{installmentId}

Get Post Dated Check

Description

Get Post Dated Check

Parameters
Path Parameters
Name Description Required Default Pattern

installmentId

installmentId

X

null

loanId

loanId

X

null

Return Type
Content Type
  • application/json

Responses
Table 499. http response codes
Code Message Datatype

200

OK

List[Section .2.456]

Samples
getPostDatedChecks

GET /loans/{loanId}/postdatedchecks

Get All Post Dated Checks

Description

Get All Post dated Checks

Parameters
Path Parameters
Name Description Required Default Pattern

loanId

loanId

X

null

Return Type
Content Type
  • application/json

Responses
Table 500. http response codes
Code Message Datatype

200

OK

List[Section .2.456]

Samples
updatePostDatedChecks

PUT /loans/{loanId}/postdatedchecks/{postDatedCheckId}

Update Post Dated Check, Bounced Check

Description

Update Post Dated Check, Bounced Check

Parameters
Path Parameters
Name Description Required Default Pattern

postDatedCheckId

postDatedCheckId

X

null

loanId

loanId

X

null

Body Parameter
Name Description Required Default Pattern

UpdatePostDatedCheckRequest

Section .2.1187

X

Query Parameters
Name Description Required Default Pattern

editType

editType

-

null

Return Type
Content Type
  • application/json

Responses
Table 501. http response codes
Code Message Datatype

200

OK

List[Section .2.1188]

Samples

.1.92. ReportMailingJobs

createReportMailingJob

POST /reportmailingjobs

Create a Report Mailing Job

Description

Mandatory Fields: name, startDateTime, stretchyReportId, emailRecipients, emailSubject, emailMessage, emailAttachmentFileFormatId, recurrence, isActive Optional Fields: description, stretchyReportParamMap

Parameters
Body Parameter
Name Description Required Default Pattern

PostReportMailingJobsRequest

Section .2.925

X

Return Type
Content Type
  • application/json

Responses
Table 502. http response codes
Code Message Datatype

200

OK

Section .2.926

Samples
deleteReportMailingJob

DELETE /reportmailingjobs/{entityId}

Delete a Report Mailing Job

Description
Parameters
Path Parameters
Name Description Required Default Pattern

entityId

entityId

X

null

Body Parameter
Name Description Required Default Pattern

body

[object]

X

Return Type
Content Type
  • application/json

Responses
Table 503. http response codes
Code Message Datatype

200

OK

Section .2.60

Samples
retrieveAllReportMailingJobs

GET /reportmailingjobs

List Report Mailing Jobs

Description

Example Requests: reportmailingjobs

Parameters
Query Parameters
Name Description Required Default Pattern

offset

offset

-

null

limit

limit

-

null

orderBy

orderBy

-

null

sortOrder

sortOrder

-

null

Return Type
Content Type
  • application/json

Responses
Table 504. http response codes
Code Message Datatype

200

OK

List[Section .2.542]

Samples
retrieveReportMailingJob

GET /reportmailingjobs/{entityId}

Retrieve a Report Mailing Job

Description

Example Requests: reportmailingjobs/1 reportmailingjobs/1?template=true

Parameters
Path Parameters
Name Description Required Default Pattern

entityId

entityId

X

null

Return Type
Content Type
  • application/json

Responses
Table 505. http response codes
Code Message Datatype

200

OK

Section .2.542

Samples
retrieveReportMailingJobTemplate

GET /reportmailingjobs/template

Retrieve Report Mailing Job Details Template

Description

This is a convenience resource. It can be useful when building maintenance user interface screens for report mailing job applications. The template data returned consists of any or all of: Field Defaults Allowed description Lists Example Request: reportmailingjobs/template

Parameters
Return Type
Content Type
  • application/json

Responses
Table 506. http response codes
Code Message Datatype

200

OK

Section .2.543

Samples
updateReportMailingJob

PUT /reportmailingjobs/{entityId}

Update a Report Mailing Job

Description
Parameters
Path Parameters
Name Description Required Default Pattern

entityId

entityId

X

null

Body Parameter
Name Description Required Default Pattern

PutReportMailingJobsRequest

Section .2.1103

X

Return Type
Content Type
  • application/json

Responses
Table 507. http response codes
Code Message Datatype

200

OK

Section .2.1104

Samples

.1.93. Reports

createReport

POST /reports

Create a Report

Description
Parameters
Body Parameter
Name Description Required Default Pattern

PostRepostRequest

Section .2.928

X

Return Type
Content Type
  • application/json

Responses
Table 508. http response codes
Code Message Datatype

200

OK

Section .2.927

Samples
deleteReport

DELETE /reports/{id}

Delete a Report

Description

Only non-core reports can be deleted.

Parameters
Path Parameters
Name Description Required Default Pattern

id

id

X

null

Return Type
Content Type
  • application/json

Responses
Table 509. http response codes
Code Message Datatype

200

OK

Section .2.61

Samples
retrieveOfficeTemplate

GET /reports/template

Retrieve Report Template

Description

This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults Allowed description Lists Example Request : reports/template

Parameters
Return Type
Content Type
  • application/json

Responses
Table 510. http response codes
Code Message Datatype

200

OK

Section .2.545

Samples
retrieveReport

GET /reports/{id}

Retrieve a Report

Description

Example Requests: reports/1 reports/1?template=true

Parameters
Path Parameters
Name Description Required Default Pattern

id

id

X

null

Return Type
Content Type
  • application/json

Responses
Table 511. http response codes
Code Message Datatype

200

OK

Section .2.544

Samples
retrieveReportList

GET /reports

List Reports

Description

Lists all reports and their parameters. Example Request: reports

Parameters
Return Type
Content Type
  • application/json

Responses
Table 512. http response codes
Code Message Datatype

200

OK

List[Section .2.544]

Samples
updateReport

PUT /reports/{id}

Update a Report

Description

Only the useReport description can be updated for core reports.

Parameters
Path Parameters
Name Description Required Default Pattern

id

id

X

null

Body Parameter
Name Description Required Default Pattern

PutReportRequest

Section .2.1106

X

Return Type
Content Type
  • application/json

Responses
Table 513. http response codes
Code Message Datatype

200

OK

Section .2.1107

Samples

.1.94. RescheduleLoans

createLoanRescheduleRequest

POST /rescheduleloans

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

[string]

-

Return Type
Content Type
  • application/json

Responses
Table 514. http response codes
Code Message Datatype

0

default response

[String]

Samples
readLoanRescheduleRequest

GET /rescheduleloans/{scheduleId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

scheduleId

X

null

Query Parameters
Name Description Required Default Pattern

command

-

null

Return Type
Content Type
  • application/json

Responses
Table 515. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveAllRescheduleRequest

GET /rescheduleloans

Description
Parameters
Query Parameters
Name Description Required Default Pattern

command

-

null

Return Type
Content Type
  • application/json

Responses
Table 516. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveTemplate9

GET /rescheduleloans/template

Description
Parameters
Return Type
Content Type
  • application/json

Responses
Table 517. http response codes
Code Message Datatype

0

default response

[String]

Samples
updateLoanRescheduleRequest

POST /rescheduleloans/{scheduleId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

scheduleId

X

null

Body Parameter
Name Description Required Default Pattern

body

[string]

-

Query Parameters
Name Description Required Default Pattern

command

-

null

Return Type
Content Type
  • application/json

Responses
Table 518. http response codes
Code Message Datatype

0

default response

[String]

Samples

.1.95. Roles

actionsOnRoles

POST /roles/{roleId}

Enable Role | Disable Role

Description

Description : Enable role in case role is disabled. | Disable the role in case role is not associated with any users. Example Request: DomainName/api/v1/roles/{roleId}?command=enable DomainName/api/v1/roles/{roleId}?command=disable

Parameters
Path Parameters
Name Description Required Default Pattern

roleId

roleId

X

null

Query Parameters
Name Description Required Default Pattern

command

command

-

null

Return Type
Content Type
  • application/json

Responses
Table 519. http response codes
Code Message Datatype

200

OK

Section .2.934

Samples
createRole

POST /roles

Create a New Role

Description

Mandatory Fields name, description

Parameters
Body Parameter
Name Description Required Default Pattern

PostRolesRequest

Section .2.931

X

Return Type
Content Type
  • application/json

Responses
Table 520. http response codes
Code Message Datatype

200

OK

Section .2.932

Samples
deleteRole

DELETE /roles/{roleId}

Delete a Role

Description

Description : Delete the role in case role is not associated with any users.

Parameters
Path Parameters
Name Description Required Default Pattern

roleId

roleId

X

null

Return Type
Content Type
  • application/json

Responses
Table 521. http response codes
Code Message Datatype

200

OK

Section .2.63

Samples
retrieveAllRoles

GET /roles

List Roles

Description

Example Requests: roles roles?fields=name

Parameters
Return Type
Content Type
  • application/json

Responses
Table 522. http response codes
Code Message Datatype

200

OK

List[Section .2.548]

Samples
retrieveRole

GET /roles/{roleId}

Retrieve a Role

Description

Example Requests: roles/1 roles/1?fields=name

Parameters
Path Parameters
Name Description Required Default Pattern

roleId

roleId

X

null

Return Type
Content Type
  • application/json

Responses
Table 523. http response codes
Code Message Datatype

200

OK

Section .2.551

Samples
retrieveRolePermissions

GET /roles/{roleId}/permissions

Retrieve a Role’s Permissions

Description

Example Requests: roles/1/permissions

Parameters
Path Parameters
Name Description Required Default Pattern

roleId

roleId

X

null

Return Type
Content Type
  • application/json

Responses
Table 524. http response codes
Code Message Datatype

200

OK

Section .2.549

Samples
updateRole

PUT /roles/{roleId}

Update a Role

Description
Parameters
Path Parameters
Name Description Required Default Pattern

roleId

roleId

X

null

Body Parameter
Name Description Required Default Pattern

PutRolesRoleIdRequest

Section .2.1113

X

Return Type
Content Type
  • application/json

Responses
Table 525. http response codes
Code Message Datatype

200

OK

Section .2.1114

Samples
updateRolePermissions

PUT /roles/{roleId}/permissions

Update a Role’s Permissions

Description
Parameters
Path Parameters
Name Description Required Default Pattern

roleId

roleId

X

null

Body Parameter
Name Description Required Default Pattern

PutRolesRoleIdPermissionsRequest

Section .2.1111

X

Return Type
Content Type
  • application/json

Responses
Table 526. http response codes
Code Message Datatype

200

OK

Section .2.1112

Samples

.1.96. RunReports

runReport

GET /runreports/{reportName}

Running a Report

Description

This resource allows you to run and receive output from pre-defined Apache Fineract reports. Reports can also be used to provide data for searching and workflow functionality. The default output is a JSON formatted \"Generic Resultset\". The Generic Resultset contains Column Heading as well as Data information. However, you can export to CSV format by simply adding \"&exportCSV=true\" to the end of your URL. If Pentaho reports have been pre-defined, they can also be run through this resource. Pentaho reports can return HTML, PDF or CSV formats. The Apache Fineract reference application uses a JQuery plugin called stretchy reporting which, itself, uses this reports resource to provide a pretty flexible reporting User Interface (UI). Example Requests: runreports/Client%20Listing?R_officeId=1 runreports/Client%20Listing?R_officeId=1&exportCSV=true runreports/OfficeIdSelectOne?R_officeId=1&parameterType=true runreports/OfficeIdSelectOne?R_officeId=1&parameterType=true&exportCSV=true runreports/Expected%20Payments%20By%20Date%20-%20Formatted?R_endDate=2013-04-30&R_loanOfficerId=-1&R_officeId=1&R_startDate=2013-04-16&output-type=HTML&R_officeId=1 runreports/Expected%20Payments%20By%20Date%20-%20Formatted?R_endDate=2013-04-30&R_loanOfficerId=-1&R_officeId=1&R_startDate=2013-04-16&output-type=XLS&R_officeId=1 runreports/Expected%20Payments%20By%20Date%20-%20Formatted?R_endDate=2013-04-30&R_loanOfficerId=-1&R_officeId=1&R_startDate=2013-04-16&output-type=CSV&R_officeId=1 runreports/Expected%20Payments%20By%20Date%20-%20Formatted?R_endDate=2013-04-30&R_loanOfficerId=-1&R_officeId=1&R_startDate=2013-04-16&output-type=PDF&R_officeId=1

Parameters
Path Parameters
Name Description Required Default Pattern

reportName

reportName

X

null

Query Parameters
Name Description Required Default Pattern

isSelfServiceUserReport

isSelfServiceUserReport

-

false

Return Type
Content Type
  • application/json

  • application/pdf

  • application/vnd.ms-excel

  • text/csv

  • text/html

Responses
Table 527. http response codes
Code Message Datatype

200

OK

Section .2.1169

Samples

.1.97. SMS

create2

POST /sms

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

[string]

-

Return Type
Content Type
  • application/json

Responses
Table 528. http response codes
Code Message Datatype

0

default response

[String]

Samples
delete6

DELETE /sms/{resourceId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

resourceId

X

null

Return Type
Content Type
  • application/json

Responses
Table 529. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveAll10

GET /sms

Description
Parameters
Return Type
Content Type
  • application/json

Responses
Table 530. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveAllSmsByStatus

GET /sms/{campaignId}/messageByStatus

Description
Parameters
Path Parameters
Name Description Required Default Pattern

campaignId

X

null

Query Parameters
Name Description Required Default Pattern

status

-

null

fromDate

-

null

toDate

-

null

locale

-

null

dateFormat

-

null

sqlSearch

-

null

offset

-

null

limit

-

null

orderBy

-

null

sortOrder

-

null

Return Type
Content Type
  • application/json

Responses
Table 531. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveOne6

GET /sms/{resourceId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

resourceId

X

null

Return Type
Content Type
  • application/json

Responses
Table 532. http response codes
Code Message Datatype

0

default response

[String]

Samples
update3

PUT /sms/{resourceId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

resourceId

X

null

Body Parameter
Name Description Required Default Pattern

body

[string]

-

Return Type
Content Type
  • application/json

Responses
Table 533. http response codes
Code Message Datatype

0

default response

[String]

Samples

.1.98. SPMAPILookUpTable

createLookupTable

POST /surveys/{surveyId}/lookuptables

Create a Lookup Table entry

Description

Add a new entry to a survey. Mandatory Fields key, score, validFrom, validTo

Parameters
Path Parameters
Name Description Required Default Pattern

surveyId

Enter surveyId

X

null

Body Parameter
Name Description Required Default Pattern

LookupTableData

Section .2.769

-

Return Type

-

Responses
Table 534. http response codes
Code Message Datatype

200

OK

<<>>

Samples
fetchLookupTables

GET /surveys/{surveyId}/lookuptables

List all Lookup Table entries

Description

List all Lookup Table entries for a survey.

Parameters
Path Parameters
Name Description Required Default Pattern

surveyId

Enter surveyId

X

null

Return Type
Content Type
  • application/json

Responses
Table 535. http response codes
Code Message Datatype

200

OK

List[Section .2.769]

Samples
findLookupTable

GET /surveys/{surveyId}/lookuptables/{key}

Retrieve a Lookup Table entry

Description

Retrieve a Lookup Table entry for a survey.

Parameters
Path Parameters
Name Description Required Default Pattern

surveyId

Enter surveyId

X

null

key

Enter key

X

null

Return Type
Content Type
  • application/json

Responses
Table 536. http response codes
Code Message Datatype

200

OK

Section .2.769

Samples

.1.99. SavingsAccount

delete18

DELETE /savingsaccounts/{accountId}

Delete a savings application

Description

At present we support hard delete of savings application so long as its in 'Submitted and pending approval' state. One the application is moves past this state, it is not possible to do a 'hard' delete of the application or the account. An API endpoint will be added to close/de-activate the savings account.

Parameters
Path Parameters
Name Description Required Default Pattern

accountId

accountId

X

null

Return Type
Content Type
  • application/json

Responses
Table 537. http response codes
Code Message Datatype

200

OK

Section .2.64

Samples
getSavingsTemplate

GET /savingsaccounts/downloadtemplate

Description
Parameters
Query Parameters
Name Description Required Default Pattern

officeId

-

null

staffId

-

null

dateFormat

-

null

Return Type

-

Content Type
  • application/vnd.ms-excel

Responses
Table 538. http response codes
Code Message Datatype

0

default response

<<>>

Samples
getSavingsTransactionTemplate

GET /savingsaccounts/transactions/downloadtemplate

Description
Parameters
Query Parameters
Name Description Required Default Pattern

officeId

-

null

dateFormat

-

null

Return Type

-

Content Type
  • application/vnd.ms-excel

Responses
Table 539. http response codes
Code Message Datatype

0

default response

<<>>

Samples
handleCommands6

POST /savingsaccounts/{accountId}

Approve savings application | Undo approval savings application | Assign Savings Officer | Unassign Savings Officer | Reject savings application | Withdraw savings application | Activate a savings account | Close a savings account | Calculate Interest on Savings Account | Post Interest on Savings Account | Block Savings Account | Unblock Savings Account | Block Savings Account Credit transactions | Unblock Savings Account Credit transactions | Block Savings Account Debit transactions | Unblock Savings Account debit transactions

Description

Approve savings application: Approves savings application so long as its in 'Submitted and pending approval' state. Undo approval savings application: Will move 'approved' savings application back to 'Submitted and pending approval' state. Assign Savings Officer: Allows you to assign Savings Officer for existing Savings Account. Unassign Savings Officer: Allows you to unassign the Savings Officer. Reject savings application: Rejects savings application so long as its in 'Submitted and pending approval' state. Withdraw savings application: Used when an applicant withdraws from the savings application. It must be in 'Submitted and pending approval' state. Activate a savings account: Results in an approved savings application being converted into an 'active' savings account. Close a savings account: Results in an Activated savings application being converted into an 'closed' savings account. closedOnDate is closure date of savings account withdrawBalance is a boolean description, true value of this field performs a withdrawal transaction with account’s running balance. Mandatory Fields: dateFormat,locale,closedOnDate Optional Fields: note, withdrawBalance, paymentTypeId, accountNumber, checkNumber, routingCode, receiptNumber, bankNumber Calculate Interest on Savings Account: Calculates interest earned on a savings account based on todays date. It does not attempt to post or credit the interest on the account. That is responsibility of the Post Interest API that will likely be called by overnight process. Post Interest on Savings Account: Calculates and Posts interest earned on a savings account based on today’s date and whether an interest posting or crediting event is due. Block Savings Account: Blocks Savings account from all types of credit and debit transactions Unblock Savings Account: Unblock a blocked account. On unblocking account, user can perform debit and credit transactions Block Savings Account Credit transactions: Savings account will be blocked from all types of credit transactions. Unblock Savings Account Credit transactions: It unblocks the Saving account’s credit operations. Now all types of credits can be transacted to Savings account Block Savings Account Debit transactions: All types of debit operations from Savings account wil be blocked Unblock Savings Account debit transactions: It unblocks the Saving account’s debit operations. Now all types of debits can be transacted from Savings account Showing request/response for 'Unassign Savings Officer'

Parameters
Path Parameters
Name Description Required Default Pattern

accountId

accountId

X

null

Body Parameter
Name Description Required Default Pattern

PostSavingsAccountsAccountIdRequest

Section .2.938

X

Query Parameters
Name Description Required Default Pattern

command

command

-

null

Return Type
Content Type
  • application/json

Responses
Table 540. http response codes
Code Message Datatype

200

OK

Section .2.939

Samples
handleGSIMCommands

POST /savingsaccounts/gsimcommands/{parentAccountId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

parentAccountId

X

null

Body Parameter
Name Description Required Default Pattern

body

[string]

-

Query Parameters
Name Description Required Default Pattern

command

-

null

Return Type
Content Type
  • application/json

Responses
Table 541. http response codes
Code Message Datatype

0

default response

[String]

Samples
postSavingsTemplate

POST /savingsaccounts/uploadtemplate

Description
Parameters
Form Parameters
Name Description Required Default Pattern

dateFormat

[string]

-

null

locale

[string]

-

null

uploadedInputStream

[file]

-

null

Return Type
Content Type
  • /

Responses
Table 542. http response codes
Code Message Datatype

0

default response

[String]

Samples
postSavingsTransactionTemplate

POST /savingsaccounts/transactions/uploadtemplate

Description
Parameters
Form Parameters
Name Description Required Default Pattern

dateFormat

[string]

-

null

locale

[string]

-

null

uploadedInputStream

[file]

-

null

Return Type
Content Type
  • /

Responses
Table 543. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveAll33

GET /savingsaccounts

List savings applications/accounts

Description

Lists savings applications/accounts Example Requests: savingsaccounts savingsaccounts?fields=name

Parameters
Query Parameters
Name Description Required Default Pattern

sqlSearch

sqlSearch

-

null

externalId

externalId

-

null

offset

offset

-

null

limit

limit

-

null

orderBy

orderBy

-

null

sortOrder

sortOrder

-

null

Return Type
Content Type
  • application/json

Responses
Table 544. http response codes
Code Message Datatype

200

OK

Section .2.555

Samples
retrieveOne24

GET /savingsaccounts/{accountId}

Retrieve a savings application/account

Description

Retrieves a savings application/account Example Requests : savingsaccounts/1 savingsaccounts/1?associations=all

Parameters
Path Parameters
Name Description Required Default Pattern

accountId

accountId

X

null

Query Parameters
Name Description Required Default Pattern

staffInSelectedOfficeOnly

staffInSelectedOfficeOnly

-

false

chargeStatus

chargeStatus

-

all

Return Type
Content Type
  • application/json

Responses
Table 545. http response codes
Code Message Datatype

200

OK

Section .2.554

Samples
submitApplication2

POST /savingsaccounts

Submit new savings application

Description

Submits new savings application Mandatory Fields: clientId or groupId, productId, submittedOnDate Optional Fields: accountNo, externalId, fieldOfficerId Inherited from Product (if not provided): nominalAnnualInterestRate, interestCompoundingPeriodType, interestCalculationType, interestCalculationDaysInYearType, minRequiredOpeningBalance, lockinPeriodFrequency, lockinPeriodFrequencyType, withdrawalFeeForTransfers, allowOverdraft, overdraftLimit, withHoldTax Additional Mandatory Field if Entity-Datatable Check is enabled for the entity of type Savings: datatables

Parameters
Body Parameter
Name Description Required Default Pattern

PostSavingsAccountsRequest

Section .2.940

X

Return Type
Content Type
  • application/json

Responses
Table 546. http response codes
Code Message Datatype

200

OK

Section .2.941

Samples
submitGSIMApplication

POST /savingsaccounts/gsim

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

[string]

-

Return Type
Content Type
  • application/json

Responses
Table 547. http response codes
Code Message Datatype

0

default response

[String]

Samples
template14

GET /savingsaccounts/template

Retrieve Savings Account Template

Description

This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults Allowed Value Lists Example Requests: savingsaccounts/template?clientId=1 savingsaccounts/template?clientId=1&productId=1

Parameters
Query Parameters
Name Description Required Default Pattern

clientId

clientId

-

null

groupId

groupId

-

null

productId

productId

-

null

staffInSelectedOfficeOnly

staffInSelectedOfficeOnly

-

false

Return Type
Content Type
  • application/json

Responses
Table 548. http response codes
Code Message Datatype

200

OK

Section .2.560

Samples
update19

PUT /savingsaccounts/{accountId}

Modify a savings application | Modify savings account withhold tax applicability

Description

Modify a savings application: Savings application can only be modified when in 'Submitted and pending approval' state. Once the application is approved, the details cannot be changed using this method. Specific api endpoints will be created to allow change of interest detail such as rate, compounding period, posting period etc Modify savings account withhold tax applicability: Savings application’s withhold tax can be modified when in 'Active' state. Once the application is activated, can modify the account withhold tax to post tax or vice-versaShowing request/response for 'Modify a savings application'

Parameters
Path Parameters
Name Description Required Default Pattern

accountId

accountId

X

null

Body Parameter
Name Description Required Default Pattern

PutSavingsAccountsAccountIdRequest

Section .2.1116

X

Query Parameters
Name Description Required Default Pattern

command

command

-

null

Return Type
Content Type
  • application/json

Responses
Table 549. http response codes
Code Message Datatype

200

OK

Section .2.1117

Samples
updateGsim

PUT /savingsaccounts/gsim/{parentAccountId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

parentAccountId

X

null

Body Parameter
Name Description Required Default Pattern

body

[string]

-

Return Type
Content Type
  • application/json

Responses
Table 550. http response codes
Code Message Datatype

0

default response

[String]

Samples

.1.100. SavingsAccountTransactions

adjustTransaction1

POST /savingsaccounts/{savingsId}/transactions/{transactionId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

savingsId

X

null

transactionId

X

null

Body Parameter
Name Description Required Default Pattern

body

[string]

-

Query Parameters
Name Description Required Default Pattern

command

-

null

Return Type
Content Type
  • application/json

Responses
Table 551. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveOne23

GET /savingsaccounts/{savingsId}/transactions/{transactionId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

savingsId

X

null

transactionId

X

null

Return Type
Content Type
  • application/json

Responses
Table 552. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveTemplate18

GET /savingsaccounts/{savingsId}/transactions/template

Description
Parameters
Path Parameters
Name Description Required Default Pattern

savingsId

X

null

Return Type
Content Type
  • application/json

Responses
Table 553. http response codes
Code Message Datatype

0

default response

[String]

Samples
transaction2

POST /savingsaccounts/{savingsId}/transactions

Description
Parameters
Path Parameters
Name Description Required Default Pattern

savingsId

X

null

Body Parameter
Name Description Required Default Pattern

PostSavingsAccountTransactionsRequest

Section .2.936

X

Query Parameters
Name Description Required Default Pattern

command

-

null

Return Type
Content Type
  • application/json

Responses
Table 554. http response codes
Code Message Datatype

200

OK

Section .2.937

Samples

.1.101. SavingsCharges

addSavingsAccountCharge

POST /savingsaccounts/{savingsAccountId}/charges

Create a Savings account Charge

Description

Creates a Savings account Charge Mandatory Fields for Savings account Charges: chargeId, amount chargeId, amount, dueDate, dateFormat, locale chargeId, amount, feeOnMonthDay, monthDayFormat, locale

Parameters
Path Parameters
Name Description Required Default Pattern

savingsAccountId

savingsAccountId

X

null

Body Parameter
Name Description Required Default Pattern

PostSavingsAccountsSavingsAccountIdChargesRequest

Section .2.942

X

Return Type
Content Type
  • application/json

Responses
Table 555. http response codes
Code Message Datatype

200

OK

Section .2.943

Samples
deleteSavingsAccountCharge

DELETE /savingsaccounts/{savingsAccountId}/charges/{savingsAccountChargeId}

Delete a Savings account Charge

Description

Note: Currently, A Savings account Charge may only be removed from Savings that are not yet approved.

Parameters
Path Parameters
Name Description Required Default Pattern

savingsAccountId

savingsAccountId

X

null

savingsAccountChargeId

savingsAccountChargeId

X

null

Return Type
Content Type
  • application/json

Responses
Table 556. http response codes
Code Message Datatype

200

OK

Section .2.65

Samples
payOrWaiveSavingsAccountCharge

POST /savingsaccounts/{savingsAccountId}/charges/{savingsAccountChargeId}

Pay a Savings account Charge | Waive off a Savings account Charge | Inactivate a Savings account Charge

Description

Pay a Savings account Charge: An active charge will be paid when savings account is active and having sufficient balance. Waive off a Savings account Charge: Outstanding charge amount will be waived off. Inactivate a Savings account Charge: A charge will be allowed to inactivate when savings account is active and not having any dues as of today. If charge is overpaid, corresponding charge payment transactions will be reversed. Showing request/response for 'Pay a Savings account Charge'

Parameters
Path Parameters
Name Description Required Default Pattern

savingsAccountId

savingsAccountId

X

null

savingsAccountChargeId

savingsAccountChargeId

X

null

Body Parameter
Name Description Required Default Pattern

PostSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdRequest

Section .2.944

X

Query Parameters
Name Description Required Default Pattern

command

command

-

null

Return Type
Content Type
  • application/json

Responses
Table 557. http response codes
Code Message Datatype

200

OK

Section .2.945

Samples
retrieveAllSavingsAccountCharges

GET /savingsaccounts/{savingsAccountId}/charges

List Savings Charges

Description

Lists Savings Charges Example Requests: savingsaccounts/1/charges savingsaccounts/1/charges?chargeStatus=all savingsaccounts/1/charges?chargeStatus=inactive savingsaccounts/1/charges?chargeStatus=active savingsaccounts/1/charges?fields=name,amountOrPercentage

Parameters
Path Parameters
Name Description Required Default Pattern

savingsAccountId

savingsAccountId

X

null

Query Parameters
Name Description Required Default Pattern

chargeStatus

chargeStatus

-

all

Return Type
Content Type
  • application/json

Responses
Table 558. http response codes
Code Message Datatype

200

OK

List[Section .2.556]

Samples
retrieveSavingsAccountCharge

GET /savingsaccounts/{savingsAccountId}/charges/{savingsAccountChargeId}

Retrieve a Savings account Charge

Description

Retrieves a Savings account Charge Example Requests: /savingsaccounts/1/charges/5 /savingsaccounts/1/charges/5?fields=name,amountOrPercentage

Parameters
Path Parameters
Name Description Required Default Pattern

savingsAccountId

savingsAccountId

X

null

savingsAccountChargeId

savingsAccountChargeId

X

null

Return Type
Content Type
  • application/json

Responses
Table 559. http response codes
Code Message Datatype

200

OK

Section .2.557

Samples
retrieveTemplate17

GET /savingsaccounts/{savingsAccountId}/charges/template

Retrieve Savings Charges Template

Description

This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults Allowed description Lists Example Request: savingsaccounts/1/charges/template

Parameters
Path Parameters
Name Description Required Default Pattern

savingsAccountId

savingsAccountId

X

null

Return Type
Content Type
  • application/json

Responses
Table 560. http response codes
Code Message Datatype

200

OK

Section .2.558

Samples
updateSavingsAccountCharge

PUT /savingsaccounts/{savingsAccountId}/charges/{savingsAccountChargeId}

Update a Savings account Charge

Description

Currently Savings account Charges may be updated only if the Savings account is not yet approved.

Parameters
Path Parameters
Name Description Required Default Pattern

savingsAccountId

savingsAccountId

X

null

savingsAccountChargeId

savingsAccountChargeId

X

null

Body Parameter
Name Description Required Default Pattern

PutSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdRequest

Section .2.1119

X

Return Type
Content Type
  • application/json

Responses
Table 561. http response codes
Code Message Datatype

200

OK

Section .2.1120

Samples

.1.102. SavingsProduct

create13

POST /savingsproducts

Create a Savings Product

Description

Creates a Savings Product Mandatory Fields: name, shortName, description, currencyCode, digitsAfterDecimal,inMultiplesOf, nominalAnnualInterestRate, interestCompoundingPeriodType, interestCalculationType, interestCalculationDaysInYearType,accountingRule Mandatory Fields for Cash based accounting (accountingRule = 2): savingsReferenceAccountId, savingsControlAccountId, interestOnSavingsAccountId, incomeFromFeeAccountId, transfersInSuspenseAccountId, incomeFromPenaltyAccountId Optional Fields: minRequiredOpeningBalance, lockinPeriodFrequency, lockinPeriodFrequencyType, withdrawalFeeForTransfers, paymentChannelToFundSourceMappings, feeToIncomeAccountMappings, penaltyToIncomeAccountMappings, charges, allowOverdraft, overdraftLimit, minBalanceForInterestCalculation,withHoldTax,taxGroupId,accountMapping, lienAllowed, maxAllowedLienLimit

Parameters
Body Parameter
Name Description Required Default Pattern

PostSavingsProductsRequest

Section .2.947

X

Return Type
Content Type
  • application/json

Responses
Table 562. http response codes
Code Message Datatype

200

OK

Section .2.948

Samples
delete19

DELETE /savingsproducts/{productId}

Delete a Savings Product

Description

Deletes a Savings Product

Parameters
Path Parameters
Name Description Required Default Pattern

productId

productId

X

null

Return Type
Content Type
  • application/json

Responses
Table 563. http response codes
Code Message Datatype

200

OK

Section .2.66

Samples
retrieveAll34

GET /savingsproducts

List Savings Products

Description

Lists Savings Products Example Requests: savingsproducts savingsproducts?fields=name

Parameters
Return Type
Content Type
  • application/json

Responses
Table 564. http response codes
Code Message Datatype

200

OK

List[Section .2.606]

Samples
retrieveOne25

GET /savingsproducts/{productId}

Retrieve a Savings Product

Description

Retrieves a Savings Product Example Requests: savingsproducts/1 savingsproducts/1?template=true savingsproducts/1?fields=name,description

Parameters
Path Parameters
Name Description Required Default Pattern

productId

productId

X

null

Return Type
Content Type
  • application/json

Responses
Table 565. http response codes
Code Message Datatype

200

OK

Section .2.605

Samples
retrieveTemplate19

GET /savingsproducts/template

Retrieve Savings Product Template

Description

This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults Allowed description Lists Example Request: Account Mapping: savingsproducts/template

Parameters
Return Type
Content Type
  • application/json

Responses
Table 566. http response codes
Code Message Datatype

200

OK

Section .2.610

Samples
update20

PUT /savingsproducts/{productId}

Update a Savings Product

Description

Updates a Savings Product

Parameters
Path Parameters
Name Description Required Default Pattern

productId

productId

X

null

Body Parameter
Name Description Required Default Pattern

PutSavingsProductsProductIdRequest

Section .2.1122

X

Return Type
Content Type
  • application/json

Responses
Table 567. http response codes
Code Message Datatype

200

OK

Section .2.1123

Samples

.1.103. Scheduler

changeSchedulerStatus

POST /scheduler

Activate Scheduler Jobs | Suspend Scheduler Jobs

Description

Activates the scheduler job service. | Suspends the scheduler job service.

Parameters
Query Parameters
Name Description Required Default Pattern

command

command

-

null

Return Type

-

Responses
Table 568. http response codes
Code Message Datatype

200

POST : scheduler?command=start POST : scheduler?command=stop

<<>>

Samples
retrieveStatus

GET /scheduler

Retrieve Scheduler Status

Description

Returns the scheduler status. Example Requests: scheduler

Parameters
Return Type
Content Type
  • application/json

Responses
Table 569. http response codes
Code Message Datatype

200

OK

Section .2.616

Samples

.1.104. ScoreCard

createScorecard1

POST /surveys/scorecards/{surveyId}

Create a Scorecard entry

Description

Add a new entry to a survey. Mandatory Fields clientId, createdOn, questionId, responseId, staffId

Parameters
Path Parameters
Name Description Required Default Pattern

surveyId

Enter surveyId

X

null

Body Parameter
Name Description Required Default Pattern

ScorecardData

scorecardData Section .2.1172

-

Return Type

-

Responses
Table 570. http response codes
Code Message Datatype

200

OK

<<>>

Samples
findByClient1

GET /surveys/scorecards/clients/{clientId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

clientId

X

null

Return Type
Content Type
  • application/json

Responses
Table 571. http response codes
Code Message Datatype

0

default response

List[Section .2.1172]

Samples
findBySurvey

GET /surveys/scorecards/{surveyId}

List all Scorecard entries

Description

List all Scorecard entries for a survey.

Parameters
Path Parameters
Name Description Required Default Pattern

surveyId

Enter surveyId

X

null

Return Type
Content Type
  • application/json

Responses
Table 572. http response codes
Code Message Datatype

200

OK

List[Section .2.1171]

Samples
findBySurveyAndClient

GET /surveys/scorecards/{surveyId}/clients/{clientId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

surveyId

Enter surveyId

X

null

clientId

Enter clientId

X

null

Return Type
Content Type
  • application/json

Responses
Table 573. http response codes
Code Message Datatype

0

default response

List[Section .2.1172]

Samples

.1.105. SearchAPI

advancedSearch

POST /search/advance

Adhoc query search

Description

AdHocQuery search has more search options, it is a POST request, it uses request body to send search parameters Mandatory fields:entities Optional fields:loanStatus, loanProducts, offices, loanDateOption, loanFromDate, loanToDate, includeOutStandingAmountPercentage, outStandingAmountPercentageCondition, minOutStandingAmountPercentage and maxOutStandingAmountPercentage OR outStandingAmountPercentage, includeOutstandingAmount, outstandingAmountCondition, minOutstandingAmount and maxOutstandingAmount OR outstandingAmount

Parameters
Body Parameter
Name Description Required Default Pattern

PostAdhocQuerySearchRequest

Section .2.795

X

Return Type
Content Type
  • application/json

Responses
Table 574. http response codes
Code Message Datatype

200

OK

List[Section .2.796]

Samples
retrieveAdHocSearchQueryTemplate

GET /search/template

Retrive Adhoc Search query template

Description

Mandatory Fields search?query=000000001

Parameters
Return Type
Content Type
  • application/json

Responses
Table 575. http response codes
Code Message Datatype

200

OK

Section .2.617

Samples
searchData

GET /search

Search Resources

Description

Example Requests: search?query=000000001 search?query=Petra&resource=clients,groups search?query=Petra&resource=clients,groups&exactMatch=true

Parameters
Query Parameters
Name Description Required Default Pattern

query

query

-

null

resource

resource

-

null

exactMatch

exactMatch

-

false

Return Type
Content Type
  • application/json

Responses
Table 576. http response codes
Code Message Datatype

200

OK

List[Section .2.617]

Samples

.1.106. SelfAccountTransfer

create14

POST /self/accounttransfers

Create new Transfer

Description

Ability to create new transfer of monetary funds from one account to another. Example Requests: self/accounttransfers/

Parameters
Body Parameter
Name Description Required Default Pattern

body

[string]

-

Query Parameters
Name Description Required Default Pattern

type

-

Return Type
Content Type
  • application/json

Responses
Table 577. http response codes
Code Message Datatype

200

OK

List[Section .2.901]

Samples
template15

GET /self/accounttransfers/template

Retrieve Account Transfer Template

Description

Returns list of loan/savings accounts that can be used for account transfer Example Requests: self/accounttransfers/template

Parameters
Query Parameters
Name Description Required Default Pattern

type

-

Return Type

array[Section .2.91]

Content Type
  • application/json

Responses
Table 578. http response codes
Code Message Datatype

200

OK

List[Section .2.91]

Samples

.1.107. SelfAuthentication

authenticate1

POST /self/authentication

Verify authentication

Description

Authenticates the credentials provided and returns the set roles and permissions allowed. Please visit this link for more info - demo.fineract.dev/fineract-provider/legacy-docs/apiLive.htm#selfbasicauth

Parameters
Body Parameter
Name Description Required Default Pattern

body

[string]

-

Return Type
Content Type
  • application/json

Responses
Table 579. http response codes
Code Message Datatype

200

OK

Section .2.949

Samples

.1.108. SelfClient

addNewClientImage2

POST /self/clients/{clientId}/images

Description
Parameters
Path Parameters
Name Description Required Default Pattern

clientId

X

null

Form Parameters
Name Description Required Default Pattern

dateFormat

[string]

-

null

locale

[string]

-

null

uploadedInputStream

[file]

-

null

Header Parameters
Name Description Required Default Pattern

Content-Length

-

null

Return Type
Content Type
  • application/json

Responses
Table 580. http response codes
Code Message Datatype

0

default response

[String]

Samples
deleteClientImage1

DELETE /self/clients/{clientId}/images

Description
Parameters
Path Parameters
Name Description Required Default Pattern

clientId

X

null

Return Type
Content Type
  • application/json

Responses
Table 581. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveAll36

GET /self/clients

List Clients associated to the user

Description

The list capability of clients can support pagination and sorting. Example Requests: self/clients self/clients?fields=displayName,officeName self/clients?offset=10&limit=50 self/clients?orderBy=displayName&sortOrder=DESC

Parameters
Query Parameters
Name Description Required Default Pattern

displayName

displayName

-

null

firstName

firstName

-

null

lastName

lastName

-

null

offset

offset

-

null

status

status

-

null

limit

limit

-

null

orderBy

orderBy

-

null

sortOrder

sortOrder

-

null

Return Type
Content Type
  • application/json

Responses
Table 582. http response codes
Code Message Datatype

200

OK

Section .2.636

Samples
retrieveAllClientCharges1

GET /self/clients/{clientId}/charges

List Client Charges

Description

The list capability of client charges supports pagination. Example Requests: self/clients/1/charges self/clients/1/charges?offset=0&limit=5

Parameters
Path Parameters
Name Description Required Default Pattern

clientId

clientId

X

null

Query Parameters
Name Description Required Default Pattern

chargeStatus

chargeStatus

-

all

pendingPayment

pendingPayment

-

null

limit

limit

-

null

offset

offset

-

null

Return Type
Content Type
  • application/json

Responses
Table 583. http response codes
Code Message Datatype

200

OK

Section .2.626

Samples
retrieveAllClientTransactions1

GET /self/clients/{clientId}/transactions

List Client Transactions

Description

The list capability of client transaction can support pagination. Example Requests: self/clients/189/transactions self/clients/189/transactions?offset=10&limit=50

Parameters
Path Parameters
Name Description Required Default Pattern

clientId

clientId

X

null

Query Parameters
Name Description Required Default Pattern

offset

offset

-

null

limit

limit

-

null

Return Type
Content Type
  • application/json

Responses
Table 584. http response codes
Code Message Datatype

200

OK

Section .2.629

Samples
retrieveAssociatedAccounts1

GET /self/clients/{clientId}/accounts

Retrieve client accounts overview

Description

An example of how a loan portfolio summary can be provided. This is requested in a specific use case of the community application. It is quite reasonable to add resources like this to simplify User Interface development. Example Requests: self/clients/1/accounts self/clients/1/accounts?fields=loanAccounts,savingsAccounts

Parameters
Path Parameters
Name Description Required Default Pattern

clientId

clientId

X

null

Return Type
Content Type
  • application/json

Responses
Table 585. http response codes
Code Message Datatype

200

OK

Section .2.624

Samples
retrieveClientCharge1

GET /self/clients/{clientId}/charges/{chargeId}

Retrieve a Client Charge

Description

Retrieves a Client Charge Example Requests: self/clients/1/charges/1 self/clients/1/charges/1?fields=name,id

Parameters
Path Parameters
Name Description Required Default Pattern

clientId

clientId

X

null

chargeId

chargeId

X

null

Return Type
Content Type
  • application/json

Responses
Table 586. http response codes
Code Message Datatype

200

OK

Section .2.625

Samples
retrieveClientTransaction1

GET /self/clients/{clientId}/transactions/{transactionId}

Retrieve a Client Transaction

Description

Retrieves a Client TransactionExample Requests: self/clients/1/transactions/1 self/clients/1/transactions/1?fields=id,officeName

Parameters
Path Parameters
Name Description Required Default Pattern

clientId

clientId

X

null

transactionId

transactionId

X

null

Return Type
Content Type
  • application/json

Responses
Table 587. http response codes
Code Message Datatype

200

OK

Section .2.630

Samples
retrieveImage1

GET /self/clients/{clientId}/images

Retrieve Client Image

Description

Optional arguments are identical to those of Get Image associated with an Entity (Binary file) Example Requests: self/clients/1/images

Parameters
Path Parameters
Name Description Required Default Pattern

clientId

clientId

X

null

Query Parameters
Name Description Required Default Pattern

maxWidth

-

null

maxHeight

-

null

output

-

null

Return Type

-

Responses
Table 588. http response codes
Code Message Datatype

200

OK

<<>>

Samples
retrieveObligeeDetails1

GET /self/clients/{clientId}/obligeedetails

Description
Parameters
Path Parameters
Name Description Required Default Pattern

clientId

X

null

Return Type
Content Type
  • application/json

Responses
Table 589. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveOne26

GET /self/clients/{clientId}

Retrieve a Client

Description

Retrieves a Client Example Requests: self/clients/1 self/clients/1?fields=id,displayName,officeName

Parameters
Path Parameters
Name Description Required Default Pattern

clientId

clientId

X

null

Return Type
Content Type
  • application/json

Responses
Table 590. http response codes
Code Message Datatype

200

OK

Section .2.627

Samples

.1.109. SelfDividend

createDividendDetail

POST /shareproduct/{productId}/dividend

Description
Parameters
Path Parameters
Name Description Required Default Pattern

productId

X

null

Body Parameter
Name Description Required Default Pattern

body

[string]

-

Return Type
Content Type
  • application/json

Responses
Table 591. http response codes
Code Message Datatype

0

default response

[String]

Samples
deleteDividendDetail

DELETE /shareproduct/{productId}/dividend/{dividendId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

productId

X

null

dividendId

X

null

Return Type
Content Type
  • application/json

Responses
Table 592. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveAll39

GET /shareproduct/{productId}/dividend

Description
Parameters
Path Parameters
Name Description Required Default Pattern

productId

X

null

Query Parameters
Name Description Required Default Pattern

offset

-

null

limit

-

null

orderBy

-

null

sortOrder

-

null

status

-

null

Return Type
Content Type
  • application/json

Responses
Table 593. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveDividendDetails

GET /shareproduct/{productId}/dividend/{dividendId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

dividendId

X

null

productId

X

null

Query Parameters
Name Description Required Default Pattern

offset

-

null

limit

-

null

orderBy

-

null

sortOrder

-

null

accountNo

-

null

Return Type
Content Type
  • application/json

Responses
Table 594. http response codes
Code Message Datatype

0

default response

[String]

Samples
updateDividendDetail

PUT /shareproduct/{productId}/dividend/{dividendId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

productId

X

null

dividendId

X

null

Body Parameter
Name Description Required Default Pattern

body

[string]

-

Query Parameters
Name Description Required Default Pattern

command

-

null

Return Type
Content Type
  • application/json

Responses
Table 595. http response codes
Code Message Datatype

0

default response

[String]

Samples

.1.110. SelfLoanProducts

retrieveAllLoanProducts1

GET /self/loanproducts

Description
Parameters
Query Parameters
Name Description Required Default Pattern

clientId

-

null

Return Type
Content Type
  • application/json

Responses
Table 596. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveLoanProductDetails1

GET /self/loanproducts/{productId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

productId

X

null

Query Parameters
Name Description Required Default Pattern

clientId

-

null

Return Type
Content Type
  • application/json

Responses
Table 597. http response codes
Code Message Datatype

0

default response

[String]

Samples

.1.111. SelfLoans

calculateLoanScheduleOrSubmitLoanApplication1

POST /self/loans

Calculate Loan Repayment Schedule | Submit a new Loan Application

Description

Calculate Loan Repayment Schedule: Calculates Loan Repayment Schedule Mandatory Fields: productId, principal, loanTermFrequency, loanTermFrequencyType, numberOfRepayments, repaymentEvery, repaymentFrequencyType, interestRatePerPeriod, amortizationType, interestType, interestCalculationPeriodType, expectedDisbursementDate, transactionProcessingStrategyId Submit a new Loan Application: Mandatory Fields: clientId, productId, principal, loanTermFrequency, loanTermFrequencyType, loanType, numberOfRepayments, repaymentEvery, repaymentFrequencyType, interestRatePerPeriod, amortizationType, interestType, interestCalculationPeriodType, transactionProcessingStrategyId, expectedDisbursementDate, submittedOnDate, loanType Additional Mandatory Fields if interest recalculation is enabled for product and Rest frequency not same as repayment period: recalculationRestFrequencyDate Additional Mandatory Fields if interest recalculation with interest/fee compounding is enabled for product and compounding frequency not same as repayment period: recalculationCompoundingFrequencyDate Additional Mandatory Field if Entity-Datatable Check is enabled for the entity of type loan: datatables Optional Fields: graceOnPrincipalPayment, graceOnInterestPayment, graceOnInterestCharged, linkAccountId, allowPartialPeriodInterestCalcualtion, fixedEmiAmount, maxOutstandingLoanBalance, disbursementData, graceOnArrearsAgeing, createStandingInstructionAtDisbursement (requires linkedAccountId if set to true) Showing request/response for 'Submit a new Loan Application'

Parameters
Body Parameter
Name Description Required Default Pattern

PostSelfLoansRequest

Section .2.959

X

Query Parameters
Name Description Required Default Pattern

command

command

-

null

Return Type
Content Type
  • application/json

Responses
Table 598. http response codes
Code Message Datatype

200

OK

Section .2.960

Samples
modifyLoanApplication1

PUT /self/loans/{loanId}

Update a Loan Application

Description

Loan application can only be modified when in 'Submitted and pending approval' state. Once the application is approved, the details cannot be changed using this method.

Parameters
Path Parameters
Name Description Required Default Pattern

loanId

loanId

X

null

Body Parameter
Name Description Required Default Pattern

PutSelfLoansLoanIdRequest

Section .2.1128

X

Return Type
Content Type
  • application/json

Responses
Table 599. http response codes
Code Message Datatype

200

OK

Section .2.1129

Samples
retrieveAllLoanCharges1

GET /self/loans/{loanId}/charges

List Loan Charges

Description

Lists loan Charges Example Requests: self/loans/1/charges self/loans/1/charges?fields=name,amountOrPercentage

Parameters
Path Parameters
Name Description Required Default Pattern

loanId

loanId

X

null

Return Type
Content Type
  • application/json

Responses
Table 600. http response codes
Code Message Datatype

200

OK

List[Section .2.644]

Samples
retrieveGuarantorDetails2

GET /self/loans/{loanId}/guarantors

Description
Parameters
Path Parameters
Name Description Required Default Pattern

loanId

X

null

Return Type
Content Type
  • application/json

Responses
Table 601. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveLoan1

GET /self/loans/{loanId}

Retrieve a Loan

Description

Retrieves a Loan Example Requests: self/loans/1 self/loans/1?fields=id,principal,annualInterestRate self/loans/1?fields=id,principal,annualInterestRate&associations=repaymentSchedule,transactions

Parameters
Path Parameters
Name Description Required Default Pattern

loanId

loanId

X

null

Return Type
Content Type
  • application/json

Responses
Table 602. http response codes
Code Message Datatype

200

OK

Section .2.645

Samples
retrieveLoanCharge1

GET /self/loans/{loanId}/charges/{chargeId}

Retrieve a Loan Charge

Description

Retrieves a Loan Charge Example Requests: self/loans/1/charges/1 self/loans/1/charges/1?fields=name,amountOrPercentage

Parameters
Path Parameters
Name Description Required Default Pattern

loanId

loanId

X

null

chargeId

chargeId

X

null

Return Type
Content Type
  • application/json

Responses
Table 603. http response codes
Code Message Datatype

200

OK

Section .2.644

Samples
retrieveTransaction1

GET /self/loans/{loanId}/transactions/{transactionId}

Retrieve a Loan Transaction Details

Description

Retrieves a Loan Transaction DetailsExample Request: self/loans/5/transactions/3

Parameters
Path Parameters
Name Description Required Default Pattern

loanId

loanId

X

null

transactionId

transactionId

X

null

Return Type
Content Type
  • application/json

Responses
Table 604. http response codes
Code Message Datatype

200

OK

Section .2.646

Samples
stateTransitions1

POST /self/loans/{loanId}

Applicant Withdraws from Loan Application

Description

Applicant Withdraws from Loan Application Mandatory Fields: withdrawnOnDate

Parameters
Path Parameters
Name Description Required Default Pattern

loanId

loanId

X

null

Body Parameter
Name Description Required Default Pattern

PostSelfLoansLoanIdRequest

Section .2.956

X

Query Parameters
Name Description Required Default Pattern

command

command

-

null

Return Type
Content Type
  • application/json

Responses
Table 605. http response codes
Code Message Datatype

200

OK

Section .2.957

Samples
template17

GET /self/loans/template

Retrieve Loan Details Template

Description

Retrieves Loan Details Template This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults Allowed description Lists Example Requests: self/loans/template?templateType=individual&clientId=1 self/loans/template?templateType=individual&clientId=1&productId=1

Parameters
Query Parameters
Name Description Required Default Pattern

clientId

clientId

-

null

productId

productId

-

null

templateType

templateType

-

null

Return Type
Content Type
  • application/json

Responses
Table 606. http response codes
Code Message Datatype

200

OK

Section .2.649

Samples

.1.112. SelfRunReport

runReport1

GET /self/runreports/{reportName}

Running A Report

Description

Example Requests: self/runreports/Client%20Details?R_officeId=1 self/runreports/Client%20Details?R_officeId=1&exportCSV=true

Parameters
Path Parameters
Name Description Required Default Pattern

reportName

reportName

X

null

Return Type
Content Type
  • application/json

  • application/pdf

  • application/vnd.ms-excel

  • text/csv

  • text/html

Responses
Table 607. http response codes
Code Message Datatype

200

OK

Section .2.553

Samples

.1.113. SelfSavingsAccount

modifySavingsAccountApplication

PUT /self/savingsaccounts/{accountId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

accountId

X

null

Body Parameter
Name Description Required Default Pattern

body

[string]

-

Query Parameters
Name Description Required Default Pattern

command

-

null

Return Type
Content Type
  • application/json

Responses
Table 608. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveAllSavingsAccountCharges1

GET /self/savingsaccounts/{accountId}/charges

List Savings Charges

Description

Lists Savings Charges Example Requests: self/savingsaccounts/1/charges self/savingsaccounts/1/charges?chargeStatus=inactive self/savingsaccounts/1/charges?fields=name,amountOrPercentage

Parameters
Path Parameters
Name Description Required Default Pattern

accountId

accountId

X

null

Query Parameters
Name Description Required Default Pattern

chargeStatus

chargeStatus

-

all

Return Type
Content Type
  • application/json

Responses
Table 609. http response codes
Code Message Datatype

200

OK

List[Section .2.651]

Samples
retrieveSavings

GET /self/savingsaccounts/{accountId}

Retrieve a savings account

Description

Retrieves a savings account Example Requests : self/savingsaccounts/1 self/savingsaccounts/1?associations=transactions

Parameters
Path Parameters
Name Description Required Default Pattern

accountId

accountId

X

null

Query Parameters
Name Description Required Default Pattern

chargeStatus

chargeStatus

-

all

Return Type
Content Type
  • application/json

Responses
Table 610. http response codes
Code Message Datatype

200

OK

Section .2.654

Samples
retrieveSavingsAccountCharge1

GET /self/savingsaccounts/{accountId}/charges/{savingsAccountChargeId}

Retrieve a Savings account Charge

Description

Retrieves a Savings account Charge Example Requests: self/savingsaccounts/1/charges/5 self/savingsaccounts/1/charges/5?fields=name,amountOrPercentage

Parameters
Path Parameters
Name Description Required Default Pattern

accountId

accountId

X

null

savingsAccountChargeId

savingsAccountChargeId

X

null

Return Type
Content Type
  • application/json

Responses
Table 611. http response codes
Code Message Datatype

200

OK

Section .2.652

Samples
retrieveSavingsTransaction

GET /self/savingsaccounts/{accountId}/transactions/{transactionId}

Retrieve Savings Account Transaction

Description

Retrieves Savings Account Transaction Example Requests: self/savingsaccounts/1/transactions/1

Parameters
Path Parameters
Name Description Required Default Pattern

accountId

accountId

X

null

transactionId

transactionId

X

null

Return Type
Content Type
  • application/json

Responses
Table 612. http response codes
Code Message Datatype

200

OK

Section .2.653

Samples
submitSavingsAccountApplication

POST /self/savingsaccounts

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

[string]

-

Query Parameters
Name Description Required Default Pattern

command

-

null

Return Type
Content Type
  • application/json

Responses
Table 613. http response codes
Code Message Datatype

0

default response

[String]

Samples
template18

GET /self/savingsaccounts/template

Description
Parameters
Query Parameters
Name Description Required Default Pattern

clientId

-

null

productId

-

null

Return Type
Content Type
  • application/json

Responses
Table 614. http response codes
Code Message Datatype

0

default response

[String]

Samples

.1.114. SelfSavingsProducts

retrieveAll38

GET /self/savingsproducts

Description
Parameters
Query Parameters
Name Description Required Default Pattern

clientId

-

null

Return Type
Content Type
  • application/json

Responses
Table 615. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveOne27

GET /self/savingsproducts/{productId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

productId

X

null

Query Parameters
Name Description Required Default Pattern

clientId

-

null

Return Type
Content Type
  • application/json

Responses
Table 616. http response codes
Code Message Datatype

0

default response

[String]

Samples

.1.115. SelfScoreCard

createScorecard

POST /self/surveys/scorecards/{surveyId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

surveyId

X

null

Body Parameter
Name Description Required Default Pattern

ScorecardData

Section .2.1172

-

Return Type

-

Content Type
  • application/json

Responses
Table 617. http response codes
Code Message Datatype

0

default response

<<>>

Samples
findByClient

GET /self/surveys/scorecards/clients/{clientId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

clientId

X

null

Return Type
Content Type
  • application/json

Responses
Table 618. http response codes
Code Message Datatype

0

default response

List[Section .2.1172]

Samples

.1.116. SelfServiceRegistration

createSelfServiceRegistrationRequest

POST /self/registration

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

[string]

-

Return Type
Content Type
  • application/json

Responses
Table 619. http response codes
Code Message Datatype

0

default response

[String]

Samples
createSelfServiceUser

POST /self/registration/user

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

[string]

-

Return Type
Content Type
  • application/json

Responses
Table 620. http response codes
Code Message Datatype

0

default response

[String]

Samples

.1.117. SelfShareAccounts

createAccount1

POST /self/shareaccounts

Submit new share application

Description

Mandatory fields: clientId, productId, submittedDate, savingsAccountId, requestedShares, applicationDate Optional Fields accountNo, externalId Inherited from Product (if not provided) minimumActivePeriod, minimumActivePeriodFrequencyType, lockinPeriodFrequency, lockinPeriodFrequencyType.

Parameters
Body Parameter
Name Description Required Default Pattern

body

[string]

-

Return Type
Content Type
  • application/json

Responses
Table 621. http response codes
Code Message Datatype

200

OK

List[Section .2.900]

Samples
retrieveShareAccount

GET /self/shareaccounts/{accountId}

Retrieve a share application/account

Description
Example Requests:  self/shareaccounts/12
Parameters
Path Parameters
Name Description Required Default Pattern

accountId

X

null

Return Type
Content Type
  • application/json

Responses
Table 622. http response codes
Code Message Datatype

0

default response

[String]

Samples
template19

GET /self/shareaccounts/template

Retrieve Share Account Template

Description

This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults Allowed Value Lists Arguments clientId:Integer mandatory productId:Integer optionalIf entered, productId, productName and selectedProduct fields are returned. Example Requests: self/shareaccounts/template?clientId=14 self/shareaccounts/template?clientId=14&productId=3

Parameters
Query Parameters
Name Description Required Default Pattern

clientId

-

null

productId

-

null

Return Type
Content Type
  • application/json

Responses
Table 623. http response codes
Code Message Datatype

200

OK

List[Section .2.680]

Samples

.1.118. SelfShareProducts

retrieveAllProducts1

GET /self/products/share

Description
Parameters
Query Parameters
Name Description Required Default Pattern

clientId

-

null

offset

-

null

limit

-

null

Return Type
Content Type
  • application/json

Responses
Table 624. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveProduct1

GET /self/products/share/{productId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

productId

X

null

type

X

null

Query Parameters
Name Description Required Default Pattern

clientId

-

null

Return Type
Content Type
  • application/json

Responses
Table 625. http response codes
Code Message Datatype

0

default response

[String]

Samples

.1.119. SelfSpm

fetchAllSurveys

GET /self/surveys

Description
Parameters
Return Type
Content Type
  • application/json

Responses
Table 626. http response codes
Code Message Datatype

0

default response

List[Section .2.1180]

Samples

.1.120. SelfThirdPartyTransfer

add

POST /self/beneficiaries/tpt

Add TPT Beneficiary

Description

Api to add third party beneficiary linked to current user. Parameter Definitions name : Nick name for beneficiary, should be unique for an self service user officeName : Office Name of beneficiary(not id) accountNumber : Account Number of beneficiary(not id) transferLimit : Each transfer initiated to this account will not exceed this amount Example Requests: /self/beneficiaries/tpt Mandatory Fields: name, officeName, accountNumber, accountType Optional Fields: transferLimit

Parameters
Body Parameter
Name Description Required Default Pattern

PostSelfBeneficiariesTPTRequest

Section .2.950

X

Return Type
Content Type
  • application/json

Responses
Table 627. http response codes
Code Message Datatype

200

OK

Section .2.951

Samples
delete20

DELETE /self/beneficiaries/tpt/{beneficiaryId}

Delete TPT Beneficiary

Description

Api to delete third party beneficiary linked to current user. Example Requests: /self/beneficiaries/tpt/{beneficiaryId}

Parameters
Path Parameters
Name Description Required Default Pattern

beneficiaryId

X

null

Return Type
Content Type
  • application/json

Responses
Table 628. http response codes
Code Message Datatype

200

OK

Section .2.67

Samples
retrieveAll35

GET /self/beneficiaries/tpt

Get All TPT Beneficiary

Description

Api to get all third party beneficiary linked to current user. Example Requests: /self/beneficiaries/tpt

Parameters
Return Type
Content Type
  • application/json

Responses
Table 629. http response codes
Code Message Datatype

200

OK

List[Section .2.619]

Samples
template16

GET /self/beneficiaries/tpt/template

Beneficiary Third Party Transfer Template

Description

Returns Account Type enumerations. Self User is expected to know office name and account number to be able to add beneficiary. Example Requests: /self/beneficiaries/tpt/template

Parameters
Return Type
Content Type
  • application/json

Responses
Table 630. http response codes
Code Message Datatype

200

OK

Section .2.620

Samples
update21

PUT /self/beneficiaries/tpt/{beneficiaryId}

Update TPT Beneficiary

Description

Api to update third party beneficiary linked to current user. Example Requests: /self/beneficiaries/tpt/{beneficiaryId} Optional Fields: name, transferLimit

Parameters
Path Parameters
Name Description Required Default Pattern

beneficiaryId

beneficiaryId

X

null

Body Parameter
Name Description Required Default Pattern

PutSelfBeneficiariesTPTBeneficiaryIdRequest

Section .2.1125

X

Return Type
Content Type
  • application/json

Responses
Table 631. http response codes
Code Message Datatype

200

OK

Section .2.1126

Samples

.1.121. SelfUser

update22

PUT /self/user

Update User

Description

This API can be used by Self Service user to update their own user information. Currently, \"password\" and \"repeatPassword\" are the only parameters accepted.

Parameters
Body Parameter
Name Description Required Default Pattern

PutSelfUserRequest

Section .2.1131

X

Return Type
Content Type
  • /

Responses
Table 632. http response codes
Code Message Datatype

200

OK

Section .2.1132

Samples

.1.122. SelfUserDetails

fetchAuthenticatedUserData1

GET /self/userdetails

Fetch authenticated user details

Description

Checks the Authentication and returns the set roles and permissions allowed For more info visit this link - demo.fineract.dev/fineract-provider/legacy-docs/apiLive.htm#selfoauth

Parameters
Return Type
Content Type
  • application/json

Responses
Table 633. http response codes
Code Message Datatype

200

OK

Section .2.670

Samples

.1.123. ShareAccount

createAccount

POST /accounts/{type}

Submit new share application

Description

Submits new share application Mandatory Fields: clientId, productId, submittedDate, savingsAccountId, requestedShares, applicationDate Optional Fields: accountNo, externalId Inherited from Product (if not provided): minimumActivePeriod, minimumActivePeriodFrequencyType, lockinPeriodFrequency, lockinPeriodFrequencyType

Parameters
Path Parameters
Name Description Required Default Pattern

type

type

X

null

Body Parameter
Name Description Required Default Pattern

PostAccountsTypeRequest

Section .2.793

X

Return Type
Content Type
  • application/json

Responses
Table 634. http response codes
Code Message Datatype

200

OK

Section .2.794

Samples
getSharedAccountsTemplate

GET /accounts/{type}/downloadtemplate

Description
Parameters
Path Parameters
Name Description Required Default Pattern

type

type

X

null

Query Parameters
Name Description Required Default Pattern

officeId

-

null

dateFormat

-

null

Return Type

-

Content Type
  • application/vnd.ms-excel

Responses
Table 635. http response codes
Code Message Datatype

0

default response

<<>>

Samples
handleCommands2

POST /accounts/{type}/{accountId}

Approve share application | Undo approval share application | Reject share application | Activate a share account | Close a share account | Apply additional shares on a share account | Approve additional shares request on a share account | Reject additional shares request on a share account | Redeem shares on a share account

Description

Approve share application: Approves share application so long as its in 'Submitted and pending approval' state. Undo approval share application: Will move 'approved' share application back to 'Submitted and pending approval' state. Reject share application: Rejects share application so long as its in 'Submitted and pending approval' state. Activate a share account: Results in an approved share application being converted into an 'active' share account. Close a share account: Results in an Activated share application being converted into an 'closed' share account. closedDate is closure date of share account Mandatory Fields: dateFormat,locale,closedDate Apply additional shares on a share account: requestedDate is requsted date of share purchase requestedShares is number of shares to be purchase Mandatory Fields: dateFormat,locale,requestedDate, requestedShares Approve additional shares request on a share account requestedShares is Share purchase transaction ids Mandatory Fields: requestedShares Reject additional shares request on a share account: requestedShares is Share purchase transaction ids Mandatory Fields: requestedShares Redeem shares on a share account: Results redeem some/all shares from share account. requestedDate is requsted date of shares redeem requestedShares is number of shares to be redeemed Mandatory Fields: dateFormat,locale,requestedDate,requestedShares Showing request/response for 'Reject additional shares request on a share account' For more info visit this link - demo.fineract.dev/fineract-provider/legacy-docs/apiLive.htm#shareaccounts

Parameters
Path Parameters
Name Description Required Default Pattern

type

type

X

null

accountId

accountId

X

null

Body Parameter
Name Description Required Default Pattern

PostAccountsTypeAccountIdRequest

Section .2.791

X

Query Parameters
Name Description Required Default Pattern

command

command

-

null

Return Type
Content Type
  • application/json

Responses
Table 636. http response codes
Code Message Datatype

200

OK

Section .2.792

Samples
postSharedAccountsTemplate

POST /accounts/{type}/uploadtemplate

Description
Parameters
Path Parameters
Name Description Required Default Pattern

type

type

X

null

Form Parameters
Name Description Required Default Pattern

dateFormat

[string]

-

null

locale

[string]

-

null

uploadedInputStream

[file]

-

null

Return Type
Content Type
  • /

Responses
Table 637. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveAccount

GET /accounts/{type}/{accountId}

Retrieve a share application/account

Description

Retrieves a share application/account Example Requests : shareaccount/1

Parameters
Path Parameters
Name Description Required Default Pattern

accountId

accountId

X

null

type

type

X

null

Return Type
Content Type
  • application/json

Responses
Table 638. http response codes
Code Message Datatype

200

OK

Section .2.132

Samples
retrieveAllAccounts1

GET /accounts/{type}

List share applications/accounts

Description

Lists share applications/accounts Example Requests: shareaccount

Parameters
Path Parameters
Name Description Required Default Pattern

type

type

X

null

Query Parameters
Name Description Required Default Pattern

offset

offset

-

null

limit

limit

-

null

Return Type
Content Type
  • application/json

Responses
Table 639. http response codes
Code Message Datatype

200

OK

Section .2.135

Samples
template7

GET /accounts/{type}/template

Retrieve Share Account Template

Description

This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults Allowed Value Lists Example Requests: accounts/share/template?clientId=1 accounts/share/template?clientId=1&productId=1

Parameters
Path Parameters
Name Description Required Default Pattern

type

type

X

null

Query Parameters
Name Description Required Default Pattern

clientId

clientId

-

null

productId

productId

-

null

Return Type
Content Type
  • application/json

Responses
Table 640. http response codes
Code Message Datatype

200

OK

Section .2.138

Samples
updateAccount

PUT /accounts/{type}/{accountId}

Modify a share application

Description

Share application can only be modified when in 'Submitted and pending approval' state. Once the application is approved, the details cannot be changed using this method. Specific api endpoints will be created to allow change of interest detail such as rate, compounding period, posting period etc

Parameters
Path Parameters
Name Description Required Default Pattern

type

type

X

null

accountId

accountId

X

null

Body Parameter
Name Description Required Default Pattern

PutAccountsTypeAccountIdRequest

Section .2.994

X

Return Type
Content Type
  • application/json

Responses
Table 641. http response codes
Code Message Datatype

200

OK

Section .2.995

Samples

.1.124. SpmSurveys

activateOrDeactivateSurvey

POST /surveys/{id}

Deactivate Survey

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Query Parameters
Name Description Required Default Pattern

command

-

null

Return Type

-

Responses
Table 642. http response codes
Code Message Datatype

200

OK

<<>>

Samples
createSurvey

POST /surveys

Create a Survey

Description

Adds a new survey to collect client related data. Mandatory Fields countryCode, key, name, questions, responses, sequenceNo, text, description

Parameters
Body Parameter
Name Description Required Default Pattern

SurveyData

Create survey Section .2.1180

-

Return Type

-

Responses
Table 643. http response codes
Code Message Datatype

200

OK

<<>>

Samples
editSurvey

PUT /surveys/{id}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null

Body Parameter
Name Description Required Default Pattern

SurveyData

Section .2.1180

-

Return Type
Content Type
  • application/json

Responses
Table 644. http response codes
Code Message Datatype

0

default response

[String]

Samples
fetchAllSurveys1

GET /surveys

List all Surveys

Description
Parameters
Query Parameters
Name Description Required Default Pattern

isActive

-

null

Return Type
Content Type
  • application/json

Responses
Table 645. http response codes
Code Message Datatype

200

OK

List[Section .2.1180]

Samples
findSurvey

GET /surveys/{id}

Retrieve a Survey

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

Enter id

X

null

Return Type
Content Type
  • application/json

Responses
Table 646. http response codes
Code Message Datatype

200

OK

Section .2.1180

Samples

.1.125. Staff

create3

POST /staff

Create a staff member

Description

Creates a staff member. Mandatory Fields: officeId, firstname, lastname Optional Fields: isLoanOfficer, isActive

Parameters
Body Parameter
Name Description Required Default Pattern

PostStaffRequest

Section .2.961

X

Return Type
Content Type
  • application/json

Responses
Table 647. http response codes
Code Message Datatype

200

OK

Section .2.24

Samples
getTemplate1

GET /staff/downloadtemplate

Description
Parameters
Query Parameters
Name Description Required Default Pattern

officeId

-

null

dateFormat

-

null

Return Type

-

Content Type
  • application/vnd.ms-excel

Responses
Table 648. http response codes
Code Message Datatype

0

default response

<<>>

Samples
postTemplate

POST /staff/uploadtemplate

Description
Parameters
Form Parameters
Name Description Required Default Pattern

dateFormat

[string]

-

null

locale

[string]

-

null

uploadedInputStream

[file]

-

null

Return Type
Content Type
  • /

Responses
Table 649. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveAll16

GET /staff

Retrieve Staff

Description

Returns the list of staff members. Example Requests: staff Retrieve a Staff by status Returns the details of a Staff based on status. By default it Returns all the ACTIVE Staff. If status=INACTIVE, then it returns all INACTIVE Staff. and for status=ALL, it Returns both ACTIVE and INACTIVE Staff. Example Requests: staff?status=active

Parameters
Query Parameters
Name Description Required Default Pattern

officeId

officeId

-

null

staffInOfficeHierarchy

staffInOfficeHierarchy

-

false

loanOfficersOnly

loanOfficersOnly

-

false

status

status

-

active

Return Type
Content Type
  • application/json

Responses
Table 650. http response codes
Code Message Datatype

200

OK

List[Section .2.1166]

Samples
retrieveOne8

GET /staff/{staffId}

Retrieve a Staff Member

Description

Returns the details of a Staff Member. Example Requests: staff/1

Parameters
Path Parameters
Name Description Required Default Pattern

staffId

staffId

X

null

Return Type
Content Type
  • application/json

Responses
Table 651. http response codes
Code Message Datatype

200

OK

Section .2.1166

Samples
update7

PUT /staff/{staffId}

Update a Staff Member

Description

Updates the details of a staff member.

Parameters
Path Parameters
Name Description Required Default Pattern

staffId

staffId

X

null

Body Parameter
Name Description Required Default Pattern

PutStaffRequest

Section .2.1133

X

Return Type
Content Type
  • application/json

Responses
Table 652. http response codes
Code Message Datatype

200

OK

Section .2.1189

Samples

.1.126. StandingInstructions

create5

POST /standinginstructions

Create new Standing Instruction

Description

Ability to create new instruction for transfer of monetary funds from one account to another

Parameters
Body Parameter
Name Description Required Default Pattern

PostStandingInstructionsRequest

Section .2.962

X

Return Type
Content Type
  • application/json

Responses
Table 653. http response codes
Code Message Datatype

200

OK

Section .2.963

Samples
retrieveAll19

GET /standinginstructions

List Standing Instructions

Description

Example Requests: standinginstructions

Parameters
Query Parameters
Name Description Required Default Pattern

sqlSearch

sqlSearch

-

null

externalId

externalId

-

null

offset

offset

-

null

limit

limit

-

null

orderBy

orderBy

-

null

sortOrder

sortOrder

-

null

transferType

transferType

-

null

clientName

clientName

-

null

clientId

clientId

-

null

fromAccountId

fromAccountId

-

null

fromAccountType

fromAccountType

-

null

Return Type
Content Type
  • application/json

Responses
Table 654. http response codes
Code Message Datatype

200

OK

Section .2.695

Samples
retrieveOne10

GET /standinginstructions/{standingInstructionId}

Retrieve Standing Instruction

Description

Example Requests : standinginstructions/1

Parameters
Path Parameters
Name Description Required Default Pattern

standingInstructionId

standingInstructionId

X

null

Query Parameters
Name Description Required Default Pattern

sqlSearch

sqlSearch

-

null

externalId

externalId

-

null

offset

offset

-

null

limit

limit

-

null

orderBy

orderBy

-

null

sortOrder

sortOrder

-

null

Return Type
Content Type
  • application/json

Responses
Table 655. http response codes
Code Message Datatype

200

OK

Section .2.696

Samples
template6

GET /standinginstructions/template

Retrieve Standing Instruction Template

Description

This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults Allowed Value Lists Example Requests: standinginstructions/template?fromAccountType=2&fromOfficeId=1 standinginstructions/template?fromAccountType=2&fromOfficeId=1&fromClientId=1&transferType=1 standinginstructions/template?fromClientId=1&fromAccountType=2&fromAccountId=1&transferType=1

Parameters
Query Parameters
Name Description Required Default Pattern

fromOfficeId

fromOfficeId

-

null

fromClientId

fromClientId

-

null

fromAccountId

fromAccountId

-

null

fromAccountType

fromAccountType

-

null

toOfficeId

toOfficeId

-

null

toClientId

toClientId

-

null

toAccountId

toAccountId

-

null

toAccountType

toAccountType

-

null

transferType

transferType

-

null

Return Type
Content Type
  • application/json

Responses
Table 656. http response codes
Code Message Datatype

200

OK

Section .2.697

Samples
update9

PUT /standinginstructions/{standingInstructionId}

Update Standing Instruction | Delete Standing Instruction

Description

Ability to modify existing instruction for transfer of monetary funds from one account to another. PUT DomainName/api/v1/standinginstructions/1?command=update Ability to modify existing instruction for transfer of monetary funds from one account to another. PUT DomainName/api/v1/standinginstructions/1?command=delete

Parameters
Path Parameters
Name Description Required Default Pattern

standingInstructionId

standingInstructionId

X

null

Body Parameter
Name Description Required Default Pattern

PutStandingInstructionsStandingInstructionIdRequest

Section .2.1134

-

Query Parameters
Name Description Required Default Pattern

command

command

-

null

Return Type
Content Type
  • application/json

Responses
Table 657. http response codes
Code Message Datatype

200

OK

Section .2.1135

Samples

.1.127. StandingInstructionsHistory

retrieveAll20

GET /standinginstructionrunhistory

Standing Instructions Logged History

Description

The list capability of history can support pagination and sorting Example Requests : standinginstructionrunhistory standinginstructionrunhistory?orderBy=name&sortOrder=DESC standinginstructionrunhistory?offset=10&limit=50

Parameters
Query Parameters
Name Description Required Default Pattern

sqlSearch

sqlSearch

-

null

externalId

externalId

-

null

offset

offset

-

null

limit

limit

-

null

orderBy

orderBy

-

null

sortOrder

sortOrder

-

null

transferType

transferType

-

null

clientName

clientName

-

null

clientId

clientId

-

null

fromAccountId

fromAccountId

-

null

fromAccountType

fromAccountType

-

null

locale

locale

-

null

dateFormat

dateFormat

-

null

fromDate

fromDate

-

null

toDate

toDate

-

null

Return Type
Content Type
  • application/json

Responses
Table 658. http response codes
Code Message Datatype

200

OK

Section .2.694

Samples

.1.128. Survey

createDatatableEntry1

POST /survey/{surveyName}/{apptableId}

Create an entry in the survey table

Description

Insert and entry in a survey table (full fill the survey). Refer Link for sample Body: [ demo.fineract.dev/fineract-provider/legacy-docs/apiLive.htm#survey_create ]

Parameters
Path Parameters
Name Description Required Default Pattern

surveyName

surveyName

X

null

apptableId

apptableId

X

null

Body Parameter
Name Description Required Default Pattern

PostSurveySurveyNameApptableIdRequest

Section .2.964

X

Return Type
Content Type
  • application/json

Responses
Table 659. http response codes
Code Message Datatype

200

OK

Section .2.965

Samples
deleteDatatableEntries2

DELETE /survey/{surveyName}/{clientId}/{fulfilledId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

surveyName

X

null

clientId

X

null

fulfilledId

X

null

Return Type
Content Type
  • application/json

Responses
Table 660. http response codes
Code Message Datatype

0

default response

[String]

Samples
getClientSurveyOverview

GET /survey/{surveyName}/{clientId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

surveyName

X

null

clientId

X

null

Return Type
Content Type
  • application/json

Responses
Table 661. http response codes
Code Message Datatype

0

default response

[String]

Samples
getSurveyEntry

GET /survey/{surveyName}/{clientId}/{entryId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

surveyName

X

null

clientId

X

null

entryId

X

null

Return Type
Content Type
  • application/json

Responses
Table 662. http response codes
Code Message Datatype

0

default response

[String]

Samples
register

PUT /survey/register/{surveyName}/{apptable}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

surveyName

X

null

apptable

X

null

Body Parameter
Name Description Required Default Pattern

body

[string]

-

Return Type
Content Type
  • application/json

Responses
Table 663. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveSurvey

GET /survey/{surveyName}

Retrieve survey

Description

Lists a registered survey table details and the Apache Fineract Core application table they are registered to.

Parameters
Path Parameters
Name Description Required Default Pattern

surveyName

surveyName

X

null

Return Type
Content Type
  • application/json

Responses
Table 664. http response codes
Code Message Datatype

200

OK

Section .2.700

Samples
retrieveSurveys

GET /survey

Retrieve surveys

Description

Retrieve surveys. This allows to retrieve the list of survey tables registered .

Parameters
Return Type
Content Type
  • application/json

Responses
Table 665. http response codes
Code Message Datatype

200

OK

List[Section .2.700]

Samples

.1.129. TaxComponents

createTaxCompoent

POST /taxes/component

Create a new Tax Component

Description

Creates a new Tax Component Mandatory Fields: name, percentage Optional Fields: debitAccountType, debitAcountId, creditAccountType, creditAcountId, startDate

Parameters
Body Parameter
Name Description Required Default Pattern

PostTaxesComponentsRequest

Section .2.966

X

Return Type
Content Type
  • application/json

Responses
Table 666. http response codes
Code Message Datatype

200

OK

Section .2.967

Samples
retrieveAllTaxComponents

GET /taxes/component

List Tax Components

Description

List Tax Components

Parameters
Return Type
Content Type
  • application/json

Responses
Table 667. http response codes
Code Message Datatype

200

OK

List[Section .2.704]

Samples
retrieveTaxComponent

GET /taxes/component/{taxComponentId}

Retrieve Tax Component

Description

Retrieve Tax Component

Parameters
Path Parameters
Name Description Required Default Pattern

taxComponentId

taxComponentId

X

null

Return Type
Content Type
  • application/json

Responses
Table 668. http response codes
Code Message Datatype

200

OK

Section .2.704

Samples
retrieveTemplate20

GET /taxes/component/template

Description
Parameters
Return Type
Content Type
  • application/json

Responses
Table 669. http response codes
Code Message Datatype

0

default response

[String]

Samples
updateTaxCompoent

PUT /taxes/component/{taxComponentId}

Update Tax Component

Description

Updates Tax component. Debit and credit account details cannot be modified. All the future tax components would be replaced with the new percentage.

Parameters
Path Parameters
Name Description Required Default Pattern

taxComponentId

taxComponentId

X

null

Body Parameter
Name Description Required Default Pattern

PutTaxesComponentsTaxComponentIdRequest

Section .2.1137

X

Return Type
Content Type
  • application/json

Responses
Table 670. http response codes
Code Message Datatype

200

OK

Section .2.1138

Samples

.1.130. TaxGroup

createTaxGroup

POST /taxes/group

Create a new Tax Group

Description

Create a new Tax Group Mandatory Fields: name and taxComponents Mandatory Fields in taxComponents: taxComponentId Optional Fields in taxComponents: id, startDate and endDate

Parameters
Body Parameter
Name Description Required Default Pattern

PostTaxesGroupRequest

Section .2.968

X

Return Type
Content Type
  • application/json

Responses
Table 671. http response codes
Code Message Datatype

200

OK

Section .2.969

Samples
retrieveAllTaxGroups

GET /taxes/group

List Tax Group

Description

List Tax Group

Parameters
Return Type
Content Type
  • application/json

Responses
Table 672. http response codes
Code Message Datatype

200

OK

List[Section .2.705]

Samples
retrieveTaxGroup

GET /taxes/group/{taxGroupId}

Retrieve Tax Group

Description

Retrieve Tax Group

Parameters
Path Parameters
Name Description Required Default Pattern

taxGroupId

taxGroupId

X

null

Return Type
Content Type
  • application/json

Responses
Table 673. http response codes
Code Message Datatype

200

OK

Section .2.705

Samples
retrieveTemplate21

GET /taxes/group/template

Description
Parameters
Return Type
Content Type
  • application/json

Responses
Table 674. http response codes
Code Message Datatype

0

default response

[String]

Samples
updateTaxGroup

PUT /taxes/group/{taxGroupId}

Update Tax Group

Description

Updates Tax Group. Only end date can be up-datable and can insert new tax components.

Parameters
Path Parameters
Name Description Required Default Pattern

taxGroupId

taxGroupId

X

null

Body Parameter
Name Description Required Default Pattern

PutTaxesGroupTaxGroupIdRequest

Section .2.1142

X

Return Type
Content Type
  • application/json

Responses
Table 675. http response codes
Code Message Datatype

200

OK

Section .2.1143

Samples

.1.131. TellerCashManagement

allocateCashToCashier

POST /tellers/{tellerId}/cashiers/{cashierId}/allocate

Allocate Cash To Cashier

Description

Mandatory Fields: Date, Amount, Currency, Notes/Comments

Parameters
Path Parameters
Name Description Required Default Pattern

tellerId

tellerId

X

null

cashierId

cashierId

X

null

Body Parameter
Name Description Required Default Pattern

PostTellersTellerIdCashiersCashierIdAllocateRequest

Section .2.973

X

Return Type
Content Type
  • application/json

Responses
Table 676. http response codes
Code Message Datatype

200

OK

Section .2.974

Samples
createCashier

POST /tellers/{tellerId}/cashiers

Create Cashiers

Description

Mandatory Fields: Cashier/staff, Fromm Date, To Date, Full Day or From time and To time Optional Fields: Description/Notes

Parameters
Path Parameters
Name Description Required Default Pattern

tellerId

tellerId

X

null

Body Parameter
Name Description Required Default Pattern

PostTellersTellerIdCashiersRequest

Section .2.977

X

Return Type
Content Type
  • application/json

Responses
Table 677. http response codes
Code Message Datatype

200

OK

Section .2.978

Samples
createTeller

POST /tellers

Create teller

Description

Mandatory Fields Teller name, OfficeId, Description, Start Date, Status Optional Fields End Date

Parameters
Body Parameter
Name Description Required Default Pattern

PostTellersRequest

Section .2.971

X

Return Type
Content Type
  • application/json

Responses
Table 678. http response codes
Code Message Datatype

200

OK

Section .2.972

Samples
deleteCashier

DELETE /tellers/{tellerId}/cashiers/{cashierId}

Delete Cashier

Description
Parameters
Path Parameters
Name Description Required Default Pattern

tellerId

tellerId

X

null

cashierId

cashierId

X

null

Return Type
Content Type
  • application/json

Responses
Table 679. http response codes
Code Message Datatype

200

OK

Section .2.68

Samples
deleteTeller

DELETE /tellers/{tellerId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

tellerId

tellerId

X

null

Return Type
Content Type
  • application/json

Responses
Table 680. http response codes
Code Message Datatype

0

default response

[String]

Samples
findCashierData

GET /tellers/{tellerId}/cashiers/{cashierId}

Retrieve a cashier

Description
Parameters
Path Parameters
Name Description Required Default Pattern

tellerId

tellerId

X

null

cashierId

cashierId

X

null

Return Type
Content Type
  • application/json

Responses
Table 681. http response codes
Code Message Datatype

200

OK

Section .2.709

Samples
findTeller

GET /tellers/{tellerId}

Retrieve tellers

Description
Parameters
Path Parameters
Name Description Required Default Pattern

tellerId

tellerId

X

null

Return Type
Content Type
  • application/json

Responses
Table 682. http response codes
Code Message Datatype

200

OK

Section .2.708

Samples
findTransactionData

GET /tellers/{tellerId}/transactions/{transactionId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

tellerId

tellerId

X

null

transactionId

transactionId

X

null

Return Type
Content Type
  • application/json

Responses
Table 683. http response codes
Code Message Datatype

0

default response

[String]

Samples
getCashierData1

GET /tellers/{tellerId}/cashiers

List Cashiers

Description
Parameters
Path Parameters
Name Description Required Default Pattern

tellerId

tellerId

X

null

Query Parameters
Name Description Required Default Pattern

fromdate

fromdate

-

null

todate

todate

-

null

Return Type
Content Type
  • application/json

Responses
Table 684. http response codes
Code Message Datatype

200

OK

Section .2.713

Samples
getCashierTemplate

GET /tellers/{tellerId}/cashiers/template

Find Cashiers

Description
Parameters
Path Parameters
Name Description Required Default Pattern

tellerId

tellerId

X

null

Return Type
Content Type
  • application/json

Responses
Table 685. http response codes
Code Message Datatype

200

OK

Section .2.714

Samples
getCashierTxnTemplate

GET /tellers/{tellerId}/cashiers/{cashierId}/transactions/template

Retrieve Cashier Transaction Template

Description
Parameters
Path Parameters
Name Description Required Default Pattern

tellerId

tellerId

X

null

cashierId

cashierId

X

null

Return Type
Content Type
  • application/json

Responses
Table 686. http response codes
Code Message Datatype

200

OK

Section .2.712

Samples
getJournalData

GET /tellers/{tellerId}/journals

Description
Parameters
Path Parameters
Name Description Required Default Pattern

tellerId

tellerId

X

null

Query Parameters
Name Description Required Default Pattern

cashierId

cashierId

-

null

dateRange

dateRange

-

null

Return Type
Content Type
  • application/json

Responses
Table 687. http response codes
Code Message Datatype

0

default response

[String]

Samples
getTellerData

GET /tellers

List all tellers

Description

Retrieves list tellers

Parameters
Query Parameters
Name Description Required Default Pattern

officeId

officeId

-

null

Return Type
Content Type
  • application/json

Responses
Table 688. http response codes
Code Message Datatype

200

OK

List[Section .2.708]

Samples
getTransactionData

GET /tellers/{tellerId}/transactions

Description
Parameters
Path Parameters
Name Description Required Default Pattern

tellerId

tellerId

X

null

Query Parameters
Name Description Required Default Pattern

dateRange

dateRange

-

null

Return Type
Content Type
  • application/json

Responses
Table 689. http response codes
Code Message Datatype

0

default response

[String]

Samples
getTransactionsForCashier

GET /tellers/{tellerId}/cashiers/{cashierId}/transactions

Retrieve Cashier Transaction

Description
Parameters
Path Parameters
Name Description Required Default Pattern

tellerId

tellerId

X

null

cashierId

cashierId

X

null

Query Parameters
Name Description Required Default Pattern

currencyCode

currencyCode

-

null

offset

offset

-

null

limit

limit

-

null

orderBy

orderBy

-

null

sortOrder

sortOrder

-

null

Return Type
Content Type
  • application/json

Responses
Table 690. http response codes
Code Message Datatype

200

OK

List[Section .2.711]

Samples
getTransactionsWtihSummaryForCashier

GET /tellers/{tellerId}/cashiers/{cashierId}/summaryandtransactions

Transactions Wtih Summary For Cashier

Description
Parameters
Path Parameters
Name Description Required Default Pattern

tellerId

tellerId

X

null

cashierId

cashierId

X

null

Query Parameters
Name Description Required Default Pattern

currencyCode

currencyCode

-

null

offset

offset

-

null

limit

limit

-

null

orderBy

orderBy

-

null

sortOrder

sortOrder

-

null

Return Type
Content Type
  • application/json

Responses
Table 691. http response codes
Code Message Datatype

200

OK

Section .2.710

Samples
settleCashFromCashier

POST /tellers/{tellerId}/cashiers/{cashierId}/settle

Settle Cash From Cashier

Description

Mandatory Fields Date, Amount, Currency, Notes/Comments

Parameters
Path Parameters
Name Description Required Default Pattern

tellerId

tellerId

X

null

cashierId

cashierId

X

null

Body Parameter
Name Description Required Default Pattern

PostTellersTellerIdCashiersCashierIdSettleRequest

Section .2.975

X

Return Type
Content Type
  • application/json

Responses
Table 692. http response codes
Code Message Datatype

200

OK

Section .2.976

Samples
updateCashier

PUT /tellers/{tellerId}/cashiers/{cashierId}

Update Cashier

Description
Parameters
Path Parameters
Name Description Required Default Pattern

tellerId

tellerId

X

null

cashierId

cashierId

X

null

Body Parameter
Name Description Required Default Pattern

PutTellersTellerIdCashiersCashierIdRequest

Section .2.1147

X

Return Type
Content Type
  • application/json

Responses
Table 693. http response codes
Code Message Datatype

200

OK

Section .2.1148

Samples
updateTeller

PUT /tellers/{tellerId}

Update teller

Description
Parameters
Path Parameters
Name Description Required Default Pattern

tellerId

tellerId

X

null

Body Parameter
Name Description Required Default Pattern

PutTellersRequest

Section .2.1144

X

Return Type
Content Type
  • application/json

Responses
Table 694. http response codes
Code Message Datatype

200

OK

Section .2.1145

Samples

.1.132. TwoFactor

getOTPDeliveryMethods

GET /twofactor

Description
Parameters
Return Type
Content Type
  • application/json

Responses
Table 695. http response codes
Code Message Datatype

0

default response

[String]

Samples
requestToken

POST /twofactor

Description
Parameters
Query Parameters
Name Description Required Default Pattern

deliveryMethod

-

null

extendedToken

-

false

Return Type
Content Type
  • application/json

Responses
Table 696. http response codes
Code Message Datatype

0

default response

[String]

Samples
updateConfiguration2

POST /twofactor/invalidate

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

[string]

-

Return Type
Content Type
  • application/json

Responses
Table 697. http response codes
Code Message Datatype

0

default response

[String]

Samples
validate

POST /twofactor/validate

Description
Parameters
Query Parameters
Name Description Required Default Pattern

token

-

null

Return Type
Content Type
  • application/json

Responses
Table 698. http response codes
Code Message Datatype

0

default response

[String]

Samples

.1.133. UserGeneratedDocuments

createTemplate

POST /templates

Add a UGD

Description

Adds a new UGD. Mandatory Fields name Example Requests: templates/1

Parameters
Body Parameter
Name Description Required Default Pattern

PostTemplatesRequest

Section .2.979

X

Return Type
Content Type
  • application/json

Responses
Table 699. http response codes
Code Message Datatype

200

OK

Section .2.980

Samples
deleteTemplate

DELETE /templates/{templateId}

Delete a UGD

Description
Parameters
Path Parameters
Name Description Required Default Pattern

templateId

templateId

X

null

Return Type
Content Type
  • application/json

Responses
Table 700. http response codes
Code Message Datatype

200

OK

Section .2.69

Samples
getTemplateByTemplate

GET /templates/{templateId}/template

Description
Parameters
Path Parameters
Name Description Required Default Pattern

templateId

X

null

Return Type
Content Type
  • application/json

Responses
Table 701. http response codes
Code Message Datatype

0

default response

[String]

Samples
mergeTemplate

POST /templates/{templateId}

Description
Parameters
Path Parameters
Name Description Required Default Pattern

templateId

X

null

Body Parameter
Name Description Required Default Pattern

body

[string]

-

Return Type
Content Type
  • text/html

Responses
Table 702. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveAll40

GET /templates

Retrieve all UGDs

Description

Example Requests: templates It is also possible to get specific UGDs by entity and type: templates?type=0&entity=0 [Entity: Id] client: 0, loan: 1 [Type: Id] Document: 0, E-Mail (not yet): 1, SMS: 2

Parameters
Query Parameters
Name Description Required Default Pattern

typeId

typeId

-

-1

entityId

entityId

-

-1

Return Type
Content Type
  • application/json

Responses
Table 703. http response codes
Code Message Datatype

200

OK

Section .2.715

Samples
retrieveOne28

GET /templates/{templateId}

Retrieve a UGD

Description

Example Requests: templates/1

Parameters
Path Parameters
Name Description Required Default Pattern

templateId

templateId

X

null

Return Type
Content Type
  • application/json

Responses
Table 704. http response codes
Code Message Datatype

200

OK

Section .2.716

Samples
saveTemplate

PUT /templates/{templateId}

Update a UGD

Description
Parameters
Path Parameters
Name Description Required Default Pattern

templateId

templateId

X

null

Body Parameter
Name Description Required Default Pattern

PutTemplatesTemplateIdRequest

Section .2.1150

X

Return Type
Content Type
  • application/json

Responses
Table 705. http response codes
Code Message Datatype

200

OK

Section .2.1151

Samples
template20

GET /templates/template

Retrieve UGD Details Template

Description

This is a convenience resource. It can be useful when building maintenance user interface screens for UGDs. The UGD data returned consists of any or all of: ARGUMENTS name String entity String type String text String optional mappers Mapper optional Example Request: templates/template

Parameters
Return Type
Content Type
  • application/json

Responses
Table 706. http response codes
Code Message Datatype

200

OK

Section .2.717

Samples

.1.134. Users

create15

POST /users

Create a User

Description

Adds new application user. Note: Password information is not required (or processed). Password details at present are auto-generated and then sent to the email account given (which is why it can take a few seconds to complete). Mandatory Fields: username, firstname, lastname, email, officeId, roles, sendPasswordToEmail Optional Fields: staffId,passwordNeverExpires,isSelfServiceUser,clients

Parameters
Body Parameter
Name Description Required Default Pattern

PostUsersRequest

Section .2.981

X

Return Type
Content Type
  • application/json

Responses
Table 707. http response codes
Code Message Datatype

200

OK

Section .2.982

Samples
delete21

DELETE /users/{userId}

Delete a User

Description

Removes the user and the associated roles and permissions.

Parameters
Path Parameters
Name Description Required Default Pattern

userId

userId

X

null

Return Type
Content Type
  • application/json

Responses
Table 708. http response codes
Code Message Datatype

200

OK

Section .2.70

Samples
getUserTemplate

GET /users/downloadtemplate

Description
Parameters
Query Parameters
Name Description Required Default Pattern

officeId

-

null

staffId

-

null

dateFormat

-

null

Return Type

-

Content Type
  • application/vnd.ms-excel

Responses
Table 709. http response codes
Code Message Datatype

0

default response

<<>>

Samples
postUsersTemplate

POST /users/uploadtemplate

Description
Parameters
Form Parameters
Name Description Required Default Pattern

dateFormat

[string]

-

null

locale

[string]

-

null

uploadedInputStream

[file]

-

null

Return Type
Content Type
  • /

Responses
Table 710. http response codes
Code Message Datatype

0

default response

[String]

Samples
retrieveAll41

GET /users

Retrieve list of users

Description

Example Requests: users users?fields=id,username,email,officeName

Parameters
Return Type
Content Type
  • application/json

Responses
Table 711. http response codes
Code Message Datatype

200

OK

List[Section .2.727]

Samples
retrieveOne29

GET /users/{userId}

Retrieve a User

Description

Example Requests: users/1 users/1?template=true users/1?fields=username,officeName

Parameters
Path Parameters
Name Description Required Default Pattern

userId

userId

X

null

Return Type
Content Type
  • application/json

Responses
Table 712. http response codes
Code Message Datatype

200

OK

Section .2.729

Samples
template22

GET /users/template

Retrieve User Details Template

Description

This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults Allowed description Lists Example Request: users/template

Parameters
Return Type
Content Type
  • application/json

Responses
Table 713. http response codes
Code Message Datatype

200

OK

Section .2.728

Samples
update24

PUT /users/{userId}

Update a User

Description

When updating a password you must provide the repeatPassword parameter also.

Parameters
Path Parameters
Name Description Required Default Pattern

userId

userId

X

null

Body Parameter
Name Description Required Default Pattern

PutUsersUserIdRequest

Section .2.1153

X

Return Type
Content Type
  • application/json

Responses
Table 714. http response codes
Code Message Datatype

200

OK

Section .2.1154

Samples

.1.135. WorkingDays

retrieveAll17

GET /workingdays

List Working days

Description

Example Requests: workingdays

Parameters
Return Type
Content Type
  • application/json

Responses
Table 715. http response codes
Code Message Datatype

200

OK

List[Section .2.730]

Samples
template4

GET /workingdays/template

Working Days Template

Description

This is a convenience resource. It can be useful when building maintenance user interface screens for working days. Example Request: workingdays/template

Parameters
Return Type
Content Type
  • application/json

Responses
Table 716. http response codes
Code Message Datatype

200

OK

Section .2.731

Samples
update8

PUT /workingdays

Update a Working Day

Description

Mandatory Fields recurrence,repaymentRescheduleType,extendTermForDailyRepayments,locale

Parameters
Body Parameter
Name Description Required Default Pattern

PutWorkingDaysRequest

Section .2.1156

X

Return Type
Content Type
  • application/json

Responses
Table 717. http response codes
Code Message Datatype

200

OK

Section .2.1157

Samples

.2. Models

.2.1. AccountingRuleData

Field Name Required Type Description Format

creditTags

List of Section .2.2

debitTags

List of Section .2.2

.2.2. AccountingTagRuleData

Field Name Required Type Description Format

id

Long

int64

tag

CodeValueData

transactionType

EnumOptionData

.2.3. AppUser

Field Name Required Type Description Format

accountNonExpired

Boolean

accountNonLocked

Boolean

appUserClientMappings

Set of Section .2.4

authorities

List of Section .2.733

credentialsNonExpired

Boolean

deleted

Boolean

displayName

String

email

String

enabled

Boolean

firstname

String

id

Long

int64

lastTimePasswordUpdated

Date

date-time

lastname

String

new

Boolean

notEnabled

Boolean

office

Office

password

String

passwordNeverExpires

Boolean

roles

Set of Section .2.1167

selfServiceUser

Boolean

staff

Staff

staffDisplayName

String

staffId

Long

int64

systemUser

Boolean

username

String

.2.4. AppUserClientMapping

Field Name Required Type Description Format

appUser

AppUser

client

Client

id

Long

int64

new

Boolean

.2.5. AppUserData

Field Name Required Type Description Format

clients

Set of Section .2.17

rowIndex

Integer

int32

selfServiceUser

Boolean

.2.6. BatchResponse

Field Name Required Type Description Format

body

String

headers

Set of Section .2.737

requestId

Long

int64

statusCode

Integer

int32

.2.7. BodyPart

Field Name Required Type Description Format

contentDisposition

ContentDisposition

entity

Object

headers

Map of [array]

mediaType

BodyPart_mediaType

messageBodyWorkers

Object

parameterizedHeaders

Map of [array]

parent

MultiPart

providers

Object

.2.8. BodyPartMediaType

Field Name Required Type Description Format

parameters

Map of [string]

subtype

String

type

String

wildcardSubtype

Boolean

wildcardType

Boolean

.2.9. CashierData

Field Name Required Type Description Format

description

String

endDate

Date

date-time

endTime

String

fullDay

Boolean

id

Long

int64

officeId

Long

int64

officeName

String

staffId

Long

int64

staffName

String

startDate

Date

date-time

startTime

String

tellerId

Long

int64

tellerName

String

.2.10. CashierTransactionData

Field Name Required Type Description Format

cashierData

CashierData

cashierId

Long

int64

cashierName

String

createdDate

Date

date-time

endDate

Date

date-time

entityId

Long

int64

entityType

String

id

Long

int64

officeId

Long

int64

officeName

String

startDate

Date

date-time

tellerId

Long

int64

tellerName

String

txnAmount

BigDecimal

txnDate

Date

date-time

txnNote

String

txnType

CashierTxnType

.2.11. CashierTxnType

Field Name Required Type Description Format

id

Integer

int32

value

String

.2.12. Changes

Field Name Required Type Description Format

amount

String

.2.13. Charge

Field Name Required Type Description Format

account

GLAccount

active

Boolean

allowedClientChargeCalculationType

Boolean

allowedClientChargeTime

Boolean

allowedLoanChargeTime

Boolean

allowedSavingsChargeCalculationType

Boolean

allowedSavingsChargeTime

Boolean

amount

BigDecimal

annualFee

Boolean

chargeCalculation

Integer

int32

chargePaymentMode

Integer

int32

chargeTimeType

Integer

int32

clientCharge

Boolean

currencyCode

String

deleted

Boolean

disbursementCharge

Boolean

enableFreeWithdrawal

Boolean

enablePaymentType

Boolean

feeInterval

Integer

int32

feeOnMonthDay

Charge_feeOnMonthDay

frequencyFreeWithdrawalCharge

Integer

int32

id

Long

int64

incomeAccountId

Long

int64

loanCharge

Boolean

maxCap

BigDecimal

minCap

BigDecimal

monthlyFee

Boolean

name

String

new

Boolean

overdueInstallment

Boolean

paymentType

PaymentType

penalty

Boolean

percentageOfApprovedAmount

Boolean

percentageOfDisbursementAmount

Boolean

restartFrequency

Integer

int32

restartFrequencyEnum

Integer

int32

savingsCharge

Boolean

taxGroup

TaxGroup

.2.14. ChargeData

Field Name Required Type Description Format

amount

BigDecimal

chargeCalculationType

EnumOptionData

chargeTimeType

EnumOptionData

currency

CurrencyData

id

Long

int64

name

String

overdueInstallmentCharge

Boolean

penalty

Boolean

.2.15. ChargeFeeOnMonthDay

Field Name Required Type Description Format

dayOfMonth

Integer

int32

month

String

Enum: JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER,

monthValue

Integer

int32

.2.16. Client

Field Name Required Type Description Format

accountNumberRequiresAutoGeneration

Boolean

activationLocalDate

date

date

active

Boolean

closed

Boolean

closureDate

date

date

displayName

String

emailAddress

String

externalId

String

firstname

String

groups

Set of Section .2.734

id

Long

int64

image

Image

lastname

String

legalForm

Integer

int32

middlename

String

mobileNo

String

new

Boolean

notActive

Boolean

notPending

Boolean

notStaff

Boolean

office

Office

officeJoiningLocalDate

date

date

pending

Boolean

proposedTransferDate

Date

date-time

rejected

Boolean

rejectedDate

date

date

reopenedDate

date

date

staff

Staff

status

Integer

int32

submittedOnDate

date

date

transferInProgress

Boolean

transferInProgressOrOnHold

Boolean

transferOnHold

Boolean

transferToOffice

Office

withdrawalDate

date

date

withdrawn

Boolean

.2.17. ClientData

Field Name Required Type Description Format

activationDate

date

date

externalId

String

firstname

String

id

Long

int64

imageId

Long

int64

imagePresent

Boolean

isAddressEnabled

Boolean

lastname

String

officeName

String

rowIndex

Integer

int32

savingsAccountId

Long

int64

timeline

Object

.2.18. CodeValueData

Field Name Required Type Description Format

active

Boolean

id

Long

int64

mandatory

Boolean

name

String

.2.19. CommandProcessingResult

Field Name Required Type Description Format

changes

Map of [object]

clientId

Long

int64

creditReport

Map of [object]

glimId

Long

int64

groupId

Long

int64

gsimId

Long

int64

loanId

Long

int64

officeId

Long

int64

productId

Long

int64

rollbackTransaction

Boolean

savingsId

Long

int64

subResourceId

Long

int64

transactionId

String

.2.20. CommandWrapper

Field Name Required Type Description Format

cacheResource

Boolean

clientId

Long

int64

create

Boolean

createDatatable

Boolean

creditBureauId

Long

int64

currencyResource

Boolean

datatableResource

Boolean

delete

Boolean

deleteDatatable

Boolean

deleteMultiple

Boolean

deleteOneToOne

Boolean

deleteOperation

Boolean

entityId

Long

int64

entityName

String

fullFilSurvey

Boolean

groupId

Long

int64

href

String

json

String

loanDisburseDetailResource

Boolean

loanId

Long

int64

noteResource

Boolean

organisationCreditBureauId

Long

int64

passwordPreferencesResource

Boolean

permissionResource

Boolean

productId

Long

int64

registerDatatable

Boolean

registerSurvey

Boolean

savingsId

Long

int64

subentityId

Long

int64

surveyResource

Boolean

taskPermissionName

String

transactionId

String

update

Boolean

updateDatatable

Boolean

updateDisbursementDate

Boolean

updateMultiple

Boolean

updateOneToOne

Boolean

updateOperation

Boolean

userResource

Boolean

workingDaysResource

Boolean

.2.21. Component

Field Name Required Type Description Format

description

String

id

Long

int64

key

String

new

Boolean

sequenceNo

Integer

int32

survey

Survey

text

String

.2.22. ComponentData

Field Name Required Type Description Format

description

String

id

Long

int64

key

String

sequenceNo

Integer

int32

text

String

.2.23. ContentDisposition

Field Name Required Type Description Format

creationDate

Date

date-time

fileName

String

modificationDate

Date

date-time

parameters

Map of [string]

readDate

Date

date-time

size

Long

int64

type

String

.2.24. CreateStaffResponse

PostStaffResponse

Field Name Required Type Description Format

officeId

Long

int64

resourceId

Long

int64

.2.25. CurrencyData

Field Name Required Type Description Format

code

String

decimalPlaces

Integer

int32

inMultiplesOf

Integer

int32

name

String

.2.26. DeleteAccountNumberFormatsResponse

DeleteAccountNumberFormatsResponse

Field Name Required Type Description Format

resourceId

Long

int64

.2.27. DeleteAccountingRulesResponse

DeleteAccountingRulesResponse

Field Name Required Type Description Format

resourceId

Long

int64

.2.28. DeleteCentersCenterIdResponse

DeleteCentersCenterIdResponse

Field Name Required Type Description Format

changes

Object

resourceId

Integer

int32

.2.29. DeleteChargesChargeIdResponse

DeleteChargesChargeIdResponse

Field Name Required Type Description Format

resourceId

Integer

int32

.2.30. DeleteClientCollateralResponse

DeleteClientCollateralResponse

Field Name Required Type Description Format

resourceId

Integer

int32

.2.31. DeleteClientsClientIdChargesChargeIdResponse

DeleteClientsClientIdChargesChargeIdResponse

Field Name Required Type Description Format

clientId

Integer

int32

officeId

Integer

int32

resourceId

Integer

int32

.2.32. DeleteClientsClientIdIdentifiersIdentifierIdResponse

DeleteClientsClientIdIdentifiersIdentifierIdResponse

Field Name Required Type Description Format

clientId

Integer

int32

officeId

Integer

int32

resourceId

Integer

int32

.2.33. DeleteClientsClientIdResponse

DeleteClientsClientIdResponse

Field Name Required Type Description Format

clientId

Integer

int32

officeId

Integer

int32

resourceId

Integer

int32

.2.34. DeleteCodeValueDataResponse

DeleteCodeValueDataResponse

Field Name Required Type Description Format

resourceId

Long

int64

.2.35. DeleteCodesResponse

DeleteCodesResponse

Field Name Required Type Description Format

resourceId

Long

int64

.2.36. DeleteCollateralProductResponse

DeleteCollateralProductResponse

Field Name Required Type Description Format

resourceId

Integer

int32

.2.37. DeleteDataTablesDatatableAppTableIdDatatableIdResponse

DeleteDataTablesDatatableAppTableIdDatatableIdResponse

Field Name Required Type Description Format

resourceId

Long

int64

.2.38. DeleteDataTablesDatatableAppTableIdResponse

DeleteDataTablesDatatableAppTableIdResponse

Field Name Required Type Description Format

resourceId

Long

int64

.2.39. DeleteDataTablesResponse

DeleteDataTablesResponse

Field Name Required Type Description Format

resourceIdentifier

String

.2.40. DeleteEntityDatatableChecksTemplateResponse

DeleteEntityDatatableChecksTemplateResponse

Field Name Required Type Description Format

resourceId

Long

int64

.2.41. DeleteEntityTypeEntityIdDocumentsResponse

DeleteEntityTypeEntityIdDocumentsResponse

Field Name Required Type Description Format

changes

Object

resourceId

Long

int64

resourceIdentifier

String

.2.42. DeleteFinancialActivityAccountsResponse

DeleteFinancialActivityAccountsResponse

Field Name Required Type Description Format

resourceId

Long

int64

.2.43. DeleteFixedDepositAccountsAccountIdResponse

DeleteFixedDepositAccountsAccountIdResponse

Field Name Required Type Description Format

clientId

Integer

int32

officeId

Integer

int32

resourceId

Integer

int32

.2.44. DeleteFixedDepositProductsProductIdResponse

DeleteFixedDepositProductsProductIdResponse

Field Name Required Type Description Format

resourceId

Integer

int32

.2.45. DeleteGLAccountsRequest

DeleteGLAccountsRequest

Field Name Required Type Description Format

resourceId

Integer

int32

.2.46. DeleteGlClosuresResponse

DeleteGlClosuresResponse

Field Name Required Type Description Format

officeId

Long

int64

resourceId

Long

int64

.2.47. DeleteGroupsGroupIdResponse

DeleteGroupsGroupIdResponse

Field Name Required Type Description Format

groupId

Integer

int32

officeId

Integer

int32

resourceId

Integer

int32

.2.48. DeleteHolidaysHolidayIdResponse

DeleteHolidaysHolidayIdResponse

Field Name Required Type Description Format

resourceId

Long

int64

.2.49. DeleteHookResponse

DeleteHookResponse

Field Name Required Type Description Format

resourceId

Long

int64

.2.50. DeleteInterestRateChartsChartIdChartSlabsResponse

DeleteInterestRateChartsChartIdChartSlabsResponse

Field Name Required Type Description Format

resourceId

Integer

int32

.2.51. DeleteInterestRateChartsChartIdResponse

DeleteInterestRateChartsChartIdResponse

Field Name Required Type Description Format

resourceId

Integer

int32

.2.52. DeleteLoansLoanIdChargesChargeIdResponse

DeleteLoansLoanIdChargesChargeIdResponse

Field Name Required Type Description Format

clientId

Long

int64

loanId

Long

int64

officeId

Long

int64

resourceId

Integer

int32

.2.53. DeleteLoansLoanIdCollateralsCollateralIdResponse

DeleteLoansLoanIdCollateralsCollateralIdResponse

Field Name Required Type Description Format

loanId

Integer

int32

resourceId

Integer

int32

.2.54. DeleteLoansLoanIdResponse

DeleteLoansLoanIdResponse

Field Name Required Type Description Format

clientId

Integer

int32

loanId

Integer

int32

officeId

Integer

int32

resourceId

Integer

int32

.2.55. DeletePaymentTypesPaymentTypeIdResponse

DeletePaymentTypesPaymentTypeIdResponse

Field Name Required Type Description Format

resourceId

Integer

int32

.2.56. DeletePostDatedCheck

DeletePostDatedCheck

Field Name Required Type Description Format

loanId

Long

int64

resourceId

Long

int64

.2.57. DeleteProvisioningCriteriaResponse

DeleteProvisioningCriteriaResponse

Field Name Required Type Description Format

resourceId

Long

int64

.2.58. DeleteRecurringDepositAccountsResponse

DeleteRecurringDepositAccountsResponse

Field Name Required Type Description Format

clientId

Integer

int32

officeId

Integer

int32

resourceId

Integer

int32

.2.59. DeleteRecurringDepositProductsProductIdResponse

DeleteRecurringDepositProductsProductIdResponse

Field Name Required Type Description Format

resourceId

Integer

int32

.2.60. DeleteReportMailingJobsResponse

DeleteReportMailingJobsResponse

Field Name Required Type Description Format

resourceId

Long

int64

.2.61. DeleteReportsResponse

DeleteReportsResponse

Field Name Required Type Description Format

resourceId

Long

int64

.2.62. DeleteResourceTypeResourceIdNotesNoteIdResponse

DeleteResourceTypeResourceIdNotesNoteIdResponse

Field Name Required Type Description Format

resourceId

Integer

int32

.2.63. DeleteRolesRoleIdResponse

DeleteRolesRoleIdResponse

Field Name Required Type Description Format

resourceId

Long

int64

.2.64. DeleteSavingsAccountsAccountIdResponse

DeleteSavingsAccountsAccountIdResponse

Field Name Required Type Description Format

clientId

Integer

int32

officeId

Integer

int32

resourceId

Integer

int32

.2.65. DeleteSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdResponse

DeleteSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdResponse

Field Name Required Type Description Format

clientId

Integer

int32

officeId

Integer

int32

resourceId

Integer

int32

savingsId

Integer

int32

.2.66. DeleteSavingsProductsProductIdResponse

DeleteSavingsProductsProductIdResponse

Field Name Required Type Description Format

resourceId

Integer

int32

.2.67. DeleteSelfBeneficiariesTPTBeneficiaryIdResponse

DeleteSelfBeneficiariesTPTBeneficiaryIdResponse

Field Name Required Type Description Format

resourceId

Integer

int32

.2.68. DeleteTellersTellerIdCashiersCashierIdResponse

DeleteTellersTellerIdCashiersCashierIdResponse

Field Name Required Type Description Format

resourceId

Long

int64

.2.69. DeleteTemplatesTemplateIdResponse

DeleteTemplatesTemplateIdResponse

Field Name Required Type Description Format

resourceId

Long

int64

.2.70. DeleteUsersUserIdResponse

DeleteUsersUserIdResponse

Field Name Required Type Description Format

changes

Object

officeId

Long

int64

resourceId

Long

int64

.2.71. Entity

Field Name Required Type Description Format

actions

List of [string]

name

String

.2.72. EnumOptionData

Field Name Required Type Description Format

code

String

id

Long

int64

value

String

.2.73. Event

Field Name Required Type Description Format

actionName

String

entityName

String

.2.74. ExtensionData

Field Name Required Type Description Format

key

X

String

value

String

.2.75. ExternalServicesPropertiesData

Field Name Required Type Description Format

name

String

value

String

.2.76. Field

Field Name Required Type Description Format

fieldName

String

fieldType

String

fieldValue

String

.2.77. FinancialActivityData

Field Name Required Type Description Format

id

Integer

int32

mappedGLAccountType

String

Enum: ASSET, LIABILITY, EQUITY, INCOME, EXPENSE,

name

String

.2.78. FloatingRate

Field Name Required Type Description Format

active

Boolean

baseLendingRate

Boolean

createdBy

AppUser

createdOn

Date

date-time

floatingRatePeriods

List of Section .2.79

id

Long

int64

modifiedBy

AppUser

modifiedOn

Date

date-time

name

String

new

Boolean

.2.79. FloatingRatePeriod

Field Name Required Type Description Format

active

Boolean

createdBy

AppUser

createdOn

Date

date-time

differentialToBaseLendingRate

Boolean

floatingRatesId

FloatingRate

fromDate

Date

date-time

id

Long

int64

interestRate

BigDecimal

modifiedBy

AppUser

modifiedOn

Date

date-time

new

Boolean

.2.80. FormDataBodyPart

Field Name Required Type Description Format

contentDisposition

ContentDisposition

entity

Object

formDataContentDisposition

FormDataContentDisposition

headers

Map of [array]

mediaType

BodyPart_mediaType

messageBodyWorkers

Object

name

String

parameterizedHeaders

Map of [array]

parent

MultiPart

providers

Object

simple

Boolean

value

String

.2.81. FormDataContentDisposition

Field Name Required Type Description Format

creationDate

Date

date-time

fileName

String

modificationDate

Date

date-time

name

String

parameters

Map of [string]

readDate

Date

date-time

size

Long

int64

type

String

.2.82. FundData

Field Name Required Type Description Format

id

Long

int64

name

String

.2.83. GLAccount

Field Name Required Type Description Format

children

List of Section .2.83

detailAccount

Boolean

disabled

Boolean

glCode

String

headerAccount

Boolean

id

Long

int64

manualEntriesAllowed

Boolean

name

String

new

Boolean

type

Integer

int32

usage

Integer

int32

.2.84. GLAccountData

Field Name Required Type Description Format

glCode

String

id

Long

int64

name

String

rowIndex

Integer

int32

tagId

CodeValueData

type

EnumOptionData

typeId

Integer

int32

.2.85. GeoCodeData

Field Name Required Type Description Format

latitude

X

String

longitude

X

String

.2.86. GetAccountNumberFormatsIdResponse

GetAccountNumberFormatsIdResponse

Field Name Required Type Description Format

accountType

EnumOptionData

id

Long

int64

prefixType

EnumOptionData

.2.87. GetAccountNumberFormatsResponseTemplate

GetAccountNumberFormatsResponseTemplate

Field Name Required Type Description Format

accountTypeOptions

List of Section .2.72

prefixTypeOptions

Map of [array]

.2.88. GetAccountOptions

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.89. GetAccountRulesResponse

GetAccountRulesResponse

Field Name Required Type Description Format

allowMultipleCreditEntries

Boolean

allowMultipleDebitEntries

Boolean

creditTags

List of Section .2.2

debitTags

List of Section .2.2

description

String

id

Long

int64

name

String

officeId

Long

int64

officeName

String

systemDefined

Boolean

.2.90. GetAccountRulesTemplateResponse

GetAccountRulesTemplateResponse

Field Name Required Type Description Format

allowedAccounts

List of Section .2.84

allowedOffices

List of Section .2.776

systemDefined

Boolean

.2.91. GetAccountTransferTemplateResponse

GetAccountTransferTemplateResponse

Field Name Required Type Description Format

accountTypeOptions

Set of Section .2.88

fromAccountTypeOptions

Set of Section .2.286

toAccountTypeOptions

Set of Section .2.286

.2.92. GetAccountTransfersFromAccountType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.93. GetAccountTransfersFromAccountTypeOptions

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.94. GetAccountTransfersFromClientOptions

Field Name Required Type Description Format

displayName

String

id

Integer

int32

officeId

Integer

int32

officeName

String

.2.95. GetAccountTransfersFromOffice

Field Name Required Type Description Format

externalId

Integer

int32

hierarchy

String

id

Integer

int32

name

String

nameDecorated

String

openingDate

date

date

.2.96. GetAccountTransfersFromOfficeOptions

Field Name Required Type Description Format

id

Integer

int32

name

String

nameDecorated

String

.2.97. GetAccountTransfersPageItems

Field Name Required Type Description Format

currency

GetAccountTransfersPageItemsCurrency

fromAccount

GetAccountTransfersPageItemsFromAccount

fromAccountType

GetAccountTransfersFromAccountType

fromClient

GetAccountTransfersFromClientOptions

fromOffice

GetAccountTransfersPageItemsFromOffice

id

Integer

int32

reversed

Boolean

toAccount

GetAccountTransfersPageItemsFromAccount

toAccountType

GetAccountTransfersPageItemsToAccountType

toClient

GetAccountTransfersFromClientOptions

toOffice

GetAccountTransfersPageItemsFromOffice

transferAmount

Float

float

transferDate

date

date

transferDescription

String

.2.98. GetAccountTransfersPageItemsCurrency

Field Name Required Type Description Format

code

String

decimalPlaces

Integer

int32

displayLabel

String

displaySymbol

String

name

String

nameCode

String

.2.99. GetAccountTransfersPageItemsFromAccount

Field Name Required Type Description Format

accountNo

Long

int64

id

Integer

int32

.2.100. GetAccountTransfersPageItemsFromOffice

Field Name Required Type Description Format

id

Integer

int32

name

String

.2.101. GetAccountTransfersPageItemsToAccountType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.102. GetAccountTransfersResponse

GetAccountTransfersResponse

Field Name Required Type Description Format

pageItems

Set of Section .2.97

totalFilteredRecords

Integer

int32

.2.103. GetAccountTransfersStatus

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.104. GetAccountTransfersTemplateRefundByTransferCurrency

Field Name Required Type Description Format

code

String

decimalPlaces

Integer

int32

displayLabel

String

displaySymbol

String

inMultiplesOf

Integer

int32

name

String

nameCode

String

.2.105. GetAccountTransfersTemplateRefundByTransferFromAccount

Field Name Required Type Description Format

accountNo

Long

int64

amtForTransfer

Float

float

clientId

Integer

int32

clientName

String

currency

GetAccountTransfersTemplateRefundByTransferCurrency

fieldOfficerId

Integer

int32

id

Integer

int32

productId

Integer

int32

productName

String

.2.106. GetAccountTransfersTemplateRefundByTransferFromAccountOptions

Field Name Required Type Description Format

accountNo

Long

int64

clientId

Integer

int32

clientName

String

currency

GetAccountTransfersTemplateRefundByTransferCurrency

fieldOfficerId

Integer

int32

id

Integer

int32

productId

Integer

int32

productName

String

.2.107. GetAccountTransfersTemplateRefundByTransferFromClient

Field Name Required Type Description Format

accountNo

Long

int64

activationDate

date

date

active

Boolean

clientClassification

Object

clientType

Object

displayName

String

firstname

String

gender

Object

groups

Object

id

Integer

int32

lastname

String

officeId

Integer

int32

officeName

String

status

GetAccountTransfersStatus

timeline

GetAccountTransfersTimeline

.2.108. GetAccountTransfersTemplateRefundByTransferFromClientOptions

Field Name Required Type Description Format

displayName

String

id

Integer

int32

officeId

Integer

int32

officeName

String

.2.109. GetAccountTransfersTemplateRefundByTransferFromOffice

Field Name Required Type Description Format

externalId

Integer

int32

hierarchy

String

id

Integer

int32

name

String

nameDecorated

String

openingDate

date

date

.2.110. GetAccountTransfersTemplateRefundByTransferFromOfficeOptions

Field Name Required Type Description Format

id

Integer

int32

name

String

nameDecorated

String

.2.111. GetAccountTransfersTemplateRefundByTransferResponse

GetAccountTransfersTemplateRefundByTransferResponse

Field Name Required Type Description Format

currency

GetAccountTransfersTemplateRefundByTransferCurrency

fromAccount

GetAccountTransfersTemplateRefundByTransferFromAccount

fromAccountOptions

Set of Section .2.106

fromAccountType

GetAccountTransfersPageItemsToAccountType

fromAccountTypeOptions

Set of Section .2.92

fromClient

GetAccountTransfersTemplateRefundByTransferFromClient

fromClientOptions

Set of Section .2.108

fromOffice

GetAccountTransfersTemplateRefundByTransferFromOffice

fromOfficeOptions

Set of Section .2.110

toAccount

GetAccountTransfersTemplateRefundByTransferToAccount

toAccountOptions

Set of Section .2.112

toAccountType

GetAccountTransfersFromAccountType

toAccountTypeOptions

Set of Section .2.92

toClient

GetAccountTransfersTemplateRefundByTransferToClient

toClientOptions

Set of Section .2.108

toOffice

GetAccountTransfersTemplateRefundByTransferFromOffice

toOfficeOptions

Set of Section .2.110

transferAmount

Float

float

transferDate

date

date

.2.112. GetAccountTransfersTemplateRefundByTransferToAccount

Field Name Required Type Description Format

accountNo

Long

int64

clientId

Integer

int32

clientName

String

currency

GetAccountTransfersTemplateRefundByTransferCurrency

fieldOfficerId

Integer

int32

id

Integer

int32

productId

Integer

int32

productName

String

.2.113. GetAccountTransfersTemplateRefundByTransferToClient

Field Name Required Type Description Format

displayName

String

id

Integer

int32

officeId

Integer

int32

officeName

String

.2.114. GetAccountTransfersTemplateResponse

GetAccountTransfersTemplateResponse

Field Name Required Type Description Format

fromAccountType

GetAccountTransfersFromAccountType

fromAccountTypeOptions

Set of Section .2.93

fromClientOptions

Set of Section .2.94

fromOffice

GetAccountTransfersFromOffice

fromOfficeOptions

Set of Section .2.96

toAccountTypeOptions

Set of Section .2.116

toOfficeOptions

Set of Section .2.117

transferAmount

Long

int64

transferDate

date

date

.2.115. GetAccountTransfersTimeline

Field Name Required Type Description Format

activatedByFirstname

String

activatedByLastname

String

activatedByUsername

String

activatedOnDate

date

date

submittedByFirstname

String

submittedByLastname

String

submittedByUsername

String

submittedOnDate

date

date

.2.116. GetAccountTransfersToAccountTypeOptions

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.117. GetAccountTransfersToOfficeOptions

Field Name Required Type Description Format

id

Integer

int32

name

String

nameDecorated

String

.2.118. GetAccountsChargeCalculationType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.119. GetAccountsChargeTimeType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.120. GetAccountsCharges

Field Name Required Type Description Format

accountId

Integer

int32

amount

Float

float

amountOrPercentage

Float

float

amountOutstanding

Float

float

amountPaid

Float

float

amountPercentageAppliedTo

Double

double

amountWaived

Float

float

amountWrittenOff

Float

float

chargeCalculationType

GetAccountsChargeCalculationType

chargeId

Integer

int32

chargeTimeType

GetAccountsChargeTimeType

currency

GetAccountsChargesCurrency

id

Integer

int32

isActive

Boolean

name

String

percentage

Double

double

.2.121. GetAccountsChargesCurrency

Field Name Required Type Description Format

code

String

decimalPlaces

Integer

int32

displayLabel

String

displaySymbol

String

name

String

nameCode

String

.2.122. GetAccountsCurrency

Field Name Required Type Description Format

code

String

decimalPlaces

Integer

int32

displayLabel

String

displaySymbol

String

inMultiplesOf

Integer

int32

name

String

nameCode

String

.2.123. GetAccountsLinkedToPocketResponse

GetAccountsLinkedToPocketResponse

Field Name Required Type Description Format

loanAccounts

Set of Section .2.454

savingAccounts

Set of Section .2.455

shareAccounts

Set of [object]

.2.124. GetAccountsLockPeriodTypeEnum

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.125. GetAccountsPageItems

Field Name Required Type Description Format

accountNo

Long

int64

clientId

Integer

int32

clientName

String

currency

GetAccountsChargesCurrency

id

Integer

int32

productId

Integer

int32

productName

String

purchasedShares

Set of Section .2.134

status

GetAccountsTypeStatus

summary

GetAccountsTypeSummary

timeline

GetAccountsTypeTimeline

.2.126. GetAccountsPurchasedShares

Field Name Required Type Description Format

accountId

Integer

int32

amount

Double

double

amountPaid

Double

double

chargeAmount

Double

double

id

Integer

int32

numberOfShares

Integer

int32

purchasedDate

date

date

purchasedPrice

Double

double

status

GetAccountsPurchasedSharesStatus

type

GetAccountsPurchasedSharesType

.2.127. GetAccountsPurchasedSharesStatus

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.128. GetAccountsPurchasedSharesType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.129. GetAccountsStatus

Field Name Required Type Description Format

active

Boolean

approved

Boolean

closed

Boolean

code

String

description

String

id

Integer

int32

rejected

Boolean

submittedAndPendingApproval

Boolean

.2.130. GetAccountsSummary

Field Name Required Type Description Format

accountNo

Long

int64

currency

GetAccountsCurrency

id

Integer

int32

productId

Integer

int32

productName

String

status

GetAccountsStatus

timeline

GetAccountsTimeline

totalApprovedShares

Integer

int32

totalPendingForApprovalShares

Integer

int32

.2.131. GetAccountsTimeline

Field Name Required Type Description Format

activatedDate

date

date

approvedByFirstname

String

approvedByLastname

String

approvedByUsername

String

approvedDate

date

date

submittedByFirstname

String

submittedByLastname

String

submittedByUsername

String

submittedOnDate

date

date

.2.132. GetAccountsTypeAccountIdResponse

GetAccountsTypeAccountIdResponse

Field Name Required Type Description Format

accountNo

Long

int64

allowDividendCalculationForInactiveClients

Boolean

charges

Set of Section .2.120

clientId

Integer

int32

clientName

String

currency

GetAccountsCurrency

currentMarketPrice

Integer

int32

dividends

List of [string]

id

Integer

int32

lockPeriodTypeEnum

GetAccountsLockPeriodTypeEnum

lockinPeriod

Integer

int32

minimumActivePeriod

Integer

int32

minimumActivePeriodTypeEnum

GetAccountsLockPeriodTypeEnum

productId

Integer

int32

productName

String

purchasedShares

Set of Section .2.126

savingsAccountId

Integer

int32

savingsAccountNumber

Long

int64

status

GetAccountsStatus

summary

GetAccountsSummary

timeline

GetAccountsTimeline

.2.133. GetAccountsTypeProductOptions

Field Name Required Type Description Format

id

Integer

int32

name

String

shortName

String

totalShares

Long

int64

.2.134. GetAccountsTypePurchasedShares

Field Name Required Type Description Format

id

Integer

int32

numberOfShares

Integer

int32

purchasedDate

String

purchasedPrice

Integer

int32

.2.135. GetAccountsTypeResponse

GetAccountsTypeResponse

Field Name Required Type Description Format

pageItems

Set of Section .2.125

totalFilteredRecords

Integer

int32

.2.136. GetAccountsTypeStatus

Field Name Required Type Description Format

active

Boolean

approved

Boolean

closed

Boolean

code

String

description

String

id

Integer

int32

rejected

Boolean

submittedAndPendingApproval

Boolean

.2.137. GetAccountsTypeSummary

Field Name Required Type Description Format

currency

GetAccountsChargesCurrency

.2.138. GetAccountsTypeTemplateResponse

GetAccountsTypeTemplateResponse

Field Name Required Type Description Format

clientId

Integer

int32

clientName

String

productOptions

Set of Section .2.133

.2.139. GetAccountsTypeTimeline

Field Name Required Type Description Format

submittedOnDate

date

date

.2.140. GetAssetType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.141. GetCachesResponse

GetCachesResponse

Field Name Required Type Description Format

cacheType

EnumOptionData

enabled

Boolean

.2.142. GetCentersAccountType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.143. GetCentersCenterIdAccountsResponse

GetCentersCenterIdAccountsResponse

Field Name Required Type Description Format

savingsAccounts

Set of Section .2.151

.2.144. GetCentersCenterIdCurrency

Field Name Required Type Description Format

code

String

decimalPlaces

Integer

int32

displayLabel

String

displaySymbol

String

inMultiplesOf

Integer

int32

name

String

nameCode

String

.2.145. GetCentersCenterIdResponse

GetCentersCenterIdResponse

Field Name Required Type Description Format

active

Boolean

hierarchy

String

id

Integer

int32

name

String

officeId

Integer

int32

officeName

String

status

GetCentersStatus

.2.146. GetCentersCenterIdStatus

Field Name Required Type Description Format

active

Boolean

approved

Boolean

closed

Boolean

code

String

description

String

id

Integer

int32

prematureClosed

Boolean

rejected

Boolean

submittedAndPendingApproval

Boolean

transferInProgress

Boolean

transferOnHold

Boolean

withdrawnByApplicant

Boolean

.2.147. GetCentersDepositType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.148. GetCentersOfficeOptions

Field Name Required Type Description Format

id

Integer

int32

name

String

nameDecorated

String

.2.149. GetCentersPageItems

Field Name Required Type Description Format

active

Boolean

hierarchy

String

id

Integer

int32

name

String

officeId

Integer

int32

officeName

String

status

GetCentersStatus

.2.150. GetCentersResponse

GetCentersResponse

Field Name Required Type Description Format

pageItems

Set of Section .2.149

totalFilteredRecords

Integer

int32

.2.151. GetCentersSavingsAccounts

Field Name Required Type Description Format

accountNo

Long

int64

accountType

GetCentersAccountType

currency

GetCentersCenterIdCurrency

depositType

GetCentersDepositType

id

Integer

int32

productId

Integer

int32

productName

String

status

GetCentersCenterIdStatus

timeline

GetCentersTimeline

.2.152. GetCentersStaffOptions

Field Name Required Type Description Format

displayName

String

id

Integer

int32

.2.153. GetCentersStatus

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.154. GetCentersTemplateResponse

GetCentersTemplateResponse

Field Name Required Type Description Format

activationDate

date

date

active

Boolean

officeId

Integer

int32

officeOptions

Set of Section .2.148

staffOptions

Set of Section .2.152

.2.155. GetCentersTimeline

Field Name Required Type Description Format

submittedByFirstname

String

submittedByLastname

String

submittedByUsername

String

submittedOnDate

date

date

.2.156. GetChargeAppliesTo

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.157. GetChargeCalculationType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.158. GetChargePaymentMode

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.159. GetChargeTimeType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.160. GetChargesAppliesTo

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.161. GetChargesAppliesToResponse

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.162. GetChargesCalculationTypeResponse

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.163. GetChargesChargeCalculationType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.164. GetChargesChargeTimeType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.165. GetChargesCurrency

Field Name Required Type Description Format

code

String

decimalPlaces

Integer

int32

displayLabel

String

displaySymbol

String

name

String

nameCode

String

.2.166. GetChargesCurrencyResponse

Field Name Required Type Description Format

code

String

decimalPlaces

Integer

int32

displayLabel

String

displaySymbol

String

name

String

nameCode

String

.2.167. GetChargesPaymentModeResponse

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.168. GetChargesResponse

GetChargesResponse

Field Name Required Type Description Format

active

String

amount

Float

float

chargeAppliesTo

GetChargesAppliesToResponse

chargeCalculationType

GetChargesCalculationTypeResponse

chargePaymentMode

GetChargesPaymentModeResponse

chargeTimeType

GetChargesTimeTypeResponse

currency

GetChargesCurrencyResponse

id

Long

int64

name

String

penalty

String

.2.169. GetChargesTemplateFeeFrequencyOptions

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.170. GetChargesTemplateLoanChargeCalculationTypeOptions

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.171. GetChargesTemplateLoanChargeTimeTypeOptions

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.172. GetChargesTemplateResponse

GetChargesTemplateResponse

Field Name Required Type Description Format

active

String

chargeAppliesToOptions

Set of Section .2.161

chargeCalculationTypeOptions

Set of Section .2.162

chargePaymentModeOptions

Set of Section .2.167

chargeTimeTypeOptions

Set of Section .2.173

currencyOptions

Set of Section .2.166

feeFrequencyOptions

Set of Section .2.169

loanChargeCalculationTypeOptions

Set of Section .2.170

loanChargeTimeTypeOptions

Set of Section .2.171

penalty

String

savingsChargeCalculationTypeOptions

Set of Section .2.170

savingsChargeTimeTypeOptions

Set of Section .2.171

.2.173. GetChargesTimeTypeResponse

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.174. GetClientChargeCalculationType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.175. GetClientChargeCurrency

Field Name Required Type Description Format

code

String

decimalPlaces

Integer

int32

displayLabel

String

displaySymbol

String

name

String

nameCode

String

.2.176. GetClientChargeTimeType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.177. GetClientClientIdAddressesResponse

GetClientClientIdAddressesResponse

Field Name Required Type Description Format

addressId

Integer

int32

addressLine1

String

addressLine2

String

addressLine3

String

addressType

String

addressTypeId

Integer

int32

city

String

client_id

Long

int64

countryId

Integer

int32

countryName

String

countyDistrict

String

createdBy

String

isActive

Boolean

postalCode

Long

int64

stateName

String

stateProvinceId

Integer

int32

street

String

townVillage

String

updatedBy

String

.2.178. GetClientIdProductIdAccountingMappings

Field Name Required Type Description Format

ShareEquityId

GetShareAccountsShareEquityId

incomeFromFeeAccountId

GetShareAccountsIncomeFromFeeAccountId

shareReferenceId

GetShareAccountsShareReferenceId

shareSuspenseId

GetShareAccountsShareSuspenseId

.2.179. GetClientIdProductIdChargeOptions

Field Name Required Type Description Format

chargeOptions

GetShareAccountsChargeOptions

.2.180. GetClientIdProductIdLockinPeriodFrequencyTypeOptions

Field Name Required Type Description Format

code

String

description

Integer

int32

id

Integer

int32

.2.181. GetClientIdProductIdMinimumActivePeriodFrequencyTypeOptions

Field Name Required Type Description Format

code

String

description

Integer

int32

id

Integer

int32

.2.182. GetClientIdProductIdProductOptions

Field Name Required Type Description Format

accountingMappingOptions

Object

accountingMappings

GetClientIdProductIdAccountingMappings

accountingRule

GetShareAccountsClientIdProductIdAccountingRule

allowDividendCalculationForInactiveClients

Boolean

chargeOptions

GetShareAccountsChargeOptions

charges

String

currency

GetShareAccountsCurrency

currencyOptions

GetShareAccountsCurrency

description

String

id

Integer

int32

lockinPeriod

Integer

int32

lockinPeriodEnum

GetShareAccountsClientIdProductIdLockPeriodTypeEnum

lockinPeriodFrequencyTypeOptions

GetClientIdProductIdLockinPeriodFrequencyTypeOptions

marketPrice

String

maximumShares

Integer

int32

minimumActivePeriod

Integer

int32

minimumActivePeriodForDividendsTypeEnum

GetShareAccountsClientIdProductIdMinimumActivePeriodForDividendsTypeEnum

minimumActivePeriodFrequencyTypeOptions

GetClientIdProductIdMinimumActivePeriodFrequencyTypeOptions

minimumShares

Integer

int32

name

String

norminalShares

Integer

int32

shareCapital

Integer

int32

shortName

String

totalShares

Integer

int32

totalSharesIssued

Integer

int32

unitPrice

Integer

int32

.2.183. GetClientStatus

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.184. GetClientTransactionsCurrency

Field Name Required Type Description Format

code

String

decimalPlaces

Integer

int32

displayLabel

String

displaySymbol

String

name

String

nameCode

String

.2.185. GetClientsAllowedDocumentTypes

Field Name Required Type Description Format

id

Integer

int32

name

String

position

Integer

int32

.2.186. GetClientsChargesPageItems

Field Name Required Type Description Format

amount

BigDecimal

amountOutstanding

BigDecimal

amountPaid

BigDecimal

amountWaived

BigDecimal

amountWrittenOff

BigDecimal

chargeCalculationType

GetClientChargeCalculationType

chargeId

Integer

int32

chargeTimeType

GetClientChargeTimeType

clientId

Integer

int32

currency

GetClientChargeCurrency

dueDate

date

date

id

Integer

int32

isActive

Boolean

isPaid

Boolean

isWaived

Boolean

name

String

penalty

Boolean

.2.187. GetClientsClientIdAccountsResponse

GetClientsClientIdAccountsResponse

Field Name Required Type Description Format

loanAccounts

Set of Section .2.200

savingsAccounts

Set of Section .2.208

.2.188. GetClientsClientIdChargesResponse

GetClientsClientIdChargesResponse

Field Name Required Type Description Format

pageItems

Set of Section .2.186

totalFilteredRecords

Integer

int32

.2.189. GetClientsClientIdIdentifiersResponse

GetClientsClientIdIdentifiersResponse

Field Name Required Type Description Format

clientId

Integer

int32

description

String

documentKey

String

documentType

GetClientsDocumentType

id

Integer

int32

.2.190. GetClientsClientIdIdentifiersTemplateResponse

GetClientsClientIdIdentifiersTemplateResponse

Field Name Required Type Description Format

allowedDocumentTypes

Set of Section .2.185

.2.191. GetClientsClientIdResponse

GetClientsClientIdResponse

Field Name Required Type Description Format

accountNo

String

activationDate

date

date

active

Boolean

displayName

String

firstname

String

groups

List of Section .2.199

id

Integer

int32

lastname

String

officeId

Integer

int32

officeName

String

savingsProductId

Integer

int32

savingsProductName

String

status

GetClientsClientIdStatus

timeline

GetClientsTimeline

.2.192. GetClientsClientIdStatus

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.193. GetClientsClientIdTransactionsResponse

GetClientsClientIdTransactionsResponse

Field Name Required Type Description Format

pageItems

Set of Section .2.204

totalFilteredRecords

Integer

int32

.2.194. GetClientsClientIdTransactionsTransactionIdResponse

GetClientsClientIdTransactionsTransactionIdResponse

Field Name Required Type Description Format

amount

BigDecimal

currency

GetClientTransactionsCurrency

date

date

date

id

Integer

int32

officeId

Integer

int32

officeName

String

reversed

Boolean

submittedOnDate

date

date

type

GetClientsClientIdTransactionsType

.2.195. GetClientsClientIdTransactionsType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.196. GetClientsColumnHeaderData

Field Name Required Type Description Format

columnDisplayType

String

columnLength

Integer

int32

columnName

String

columnType

String

columnValues

List of [string]

isColumnNullable

Boolean

isColumnPrimaryKey

Boolean

.2.197. GetClientsDataTables

Field Name Required Type Description Format

applicationTableName

String

columnHeaderData

Set of Section .2.196

registeredTableName

String

.2.198. GetClientsDocumentType

Field Name Required Type Description Format

id

Integer

int32

name

String

.2.199. GetClientsGroups

Field Name Required Type Description Format

accountNo

String

externalId

Long

int64

id

Long

int64

name

String

.2.200. GetClientsLoanAccounts

Field Name Required Type Description Format

accountNo

String

externalId

Integer

int32

id

Integer

int32

loanCycle

Integer

int32

loanType

GetClientsLoanAccountsType

productId

Integer

int32

productName

String

status

GetClientsLoanAccountsStatus

.2.201. GetClientsLoanAccountsStatus

Field Name Required Type Description Format

active

Boolean

closed

Boolean

closedObligationsMet

Boolean

closedRescheduled

Boolean

closedWrittenOff

Boolean

code

String

description

String

id

Integer

int32

overpaid

Boolean

pendingApproval

Boolean

waitingForDisbursal

Boolean

.2.202. GetClientsLoanAccountsType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.203. GetClientsOfficeOptions

Field Name Required Type Description Format

id

Integer

int32

name

String

nameDecorated

String

.2.204. GetClientsPageItems

Field Name Required Type Description Format

amount

Double

double

currency

GetClientTransactionsCurrency

date

date

date

id

Integer

int32

officeId

Integer

int32

officeName

String

reversed

Boolean

submittedOnDate

date

date

type

GetClientsClientIdTransactionsType

.2.205. GetClientsPageItemsResponse

Field Name Required Type Description Format

accountNo

String

active

Boolean

displayName

String

fullname

String

id

Long

int64

officeId

Integer

int32

officeName

String

status

GetClientStatus

.2.206. GetClientsResponse

GetClientsResponse

Field Name Required Type Description Format

pageItems

Set of Section .2.205

totalFilteredRecords

Integer

int32

.2.207. GetClientsSavingProductOptions

Field Name Required Type Description Format

allowOverdraft

Boolean

id

Integer

int32

name

String

withdrawalFeeForTransfers

Boolean

.2.208. GetClientsSavingsAccounts

Field Name Required Type Description Format

accountNo

String

currency

GetClientsSavingsAccountsCurrency

depositType

GetClientsSavingsAccountsDepositType

id

Integer

int32

productId

Integer

int32

productName

String

shortProductName

String

status

GetClientsSavingsAccountsStatus

.2.209. GetClientsSavingsAccountsCurrency

Field Name Required Type Description Format

code

String

decimalPlaces

Integer

int32

displayLabel

String

displaySymbol

String

name

String

nameCode

String

.2.210. GetClientsSavingsAccountsDepositType

Field Name Required Type Description Format

code

String

id

Integer

int32

value

String

.2.211. GetClientsSavingsAccountsStatus

Field Name Required Type Description Format

active

Boolean

approved

Boolean

closed

Boolean

code

String

id

Integer

int32

matured

Boolean

prematureClosed

Boolean

rejected

Boolean

submittedAndPendingApproval

Boolean

transferInProgress

Boolean

transferOnHold

Boolean

value

String

withdrawnByApplicant

Boolean

.2.212. GetClientsStaffOptions

Field Name Required Type Description Format

displayName

String

firstname

String

id

Integer

int32

isActive

Boolean

isLoanOfficer

Boolean

lastname

String

officeId

Integer

int32

officeName

String

.2.213. GetClientsTemplateResponse

GetClientsTemplateResponse

Field Name Required Type Description Format

activationDate

date

date

datatables

Set of Section .2.197

officeId

Integer

int32

officeOptions

Set of Section .2.203

savingProductOptions

Set of Section .2.207

staffOptions

Set of Section .2.212

.2.214. GetClientsTimeline

Field Name Required Type Description Format

activatedByFirstname

String

activatedByLastname

String

activatedByUsername

String

activatedOnDate

date

date

submittedByFirstname

String

submittedByLastname

String

submittedByUsername

String

submittedOnDate

date

date

.2.215. GetCodeValuesDataResponse

GetCodeValuesDataResponse

Field Name Required Type Description Format

description

String

id

Long

int64

name

String

position

Integer

int32

.2.216. GetCodesResponse

GetCodesResponse

Field Name Required Type Description Format

id

Long

int64

name

String

systemDefined

Boolean

.2.217. GetCollateralCurrencyResponse

Field Name Required Type Description Format

code

String

.2.218. GetCollateralManagementsResponse

GetCollateralManagementsResponse

Field Name Required Type Description Format

basePrice

BigDecimal

currency

GetCollateralCurrencyResponse

id

Long

int64

name

String

pctToBase

BigDecimal

unitType

String

.2.219. GetCollateralProductTemplate

GetCollateralProductTemplate

Field Name Required Type Description Format

currency

GetCurrencyData

.2.220. GetCollateralTypeResponse

Field Name Required Type Description Format

id

Integer

int32

name

String

.2.221. GetCollateralsTemplateAllowedTypes

Field Name Required Type Description Format

id

Integer

int32

name

String

position

Integer

int32

.2.222. GetCurrenciesResponse

GetCurrenciesResponse

Field Name Required Type Description Format

currencyOptions

List of Section .2.25

selectedCurrencyOptions

List of Section .2.25

.2.223. GetCurrencyData

Field Name Required Type Description Format

code

String

decimalPlaces

Integer

int32

displayLabel

String

displaySymbol

String

inMultiplesOf

Integer

int32

name

String

nameCode

String

.2.224. GetDataTablesResponse

GetDataTablesResponse

Field Name Required Type Description Format

applicationTableName

String

columnHeaderData

List of Section .2.1164

registeredTableName

String

.2.225. GetEntityDatatableChecksResponse

GetEntityDatatableChecksResponse

Field Name Required Type Description Format

datatableName

String

entity

String

id

Long

int64

order

Long

int64

productId

Long

int64

productName

String

status

EnumOptionData

systemDefined

Boolean

.2.226. GetEntityDatatableChecksTemplateResponse

GetEntityDatatableChecksTemplateResponse

Field Name Required Type Description Format

datatables

List of [object]

entities

List of [string]

loanProductDatas

List of Section .2.760

savingsProductDatas

List of Section .2.1170

statusClient

List of [object]

statusGroup

List of [object]

statusLoans

List of [object]

statusSavings

List of [object]

.2.227. GetEntityTypeEntityIdDocumentsResponse

GetEntityTypeEntityIdDocumentsResponse

Field Name Required Type Description Format

description

String

fileName

String

id

Long

int64

location

String

name

String

parentEntityId

Long

int64

parentEntityType

String

size

Long

int64

storageType

Integer

int32

type

String

.2.228. GetEquityType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.229. GetFieldConfigurationEntityResponse

GetFieldConfigurationEntityResponse

Field Name Required Type Description Format

entity

String

field

String

fieldConfigurationId

Integer

int32

is_enabled

String

is_mandatory

String

subentity

String

validation_regex

String

.2.230. GetFinancialActivityAccountsResponse

GetFinancialActivityAccountsResponse

Field Name Required Type Description Format

financialActivityData

FinancialActivityData

glAccountData

GLAccountData

id

Long

int64

.2.231. GetFixedDepositAccountsAccountChart

Field Name Required Type Description Format

accountId

Integer

int32

accountNumber

Long

int64

chartSlabs

Set of Section .2.236

fromDate

date

date

id

Integer

int32

periodTypes

Set of Section .2.246

.2.232. GetFixedDepositAccountsAccountChartCurrency

Field Name Required Type Description Format

code

String

decimalPlaces

Integer

int32

displayLabel

String

displaySymbol

String

name

String

nameCode

String

.2.233. GetFixedDepositAccountsAccountIdCurrency

Field Name Required Type Description Format

code

String

decimalPlaces

Integer

int32

displayLabel

String

displaySymbol

String

inMultiplesOf

Integer

int32

name

String

nameCode

String

.2.234. GetFixedDepositAccountsAccountIdResponse

GetFixedDepositAccountsAccountIdResponse

Field Name Required Type Description Format

accountChart

GetFixedDepositAccountsAccountChart

accountNo

Long

int64

clientId

Integer

int32

clientName

String

currency

GetFixedDepositAccountsAccountIdCurrency

depositAmount

Float

float

depositPeriod

Integer

int32

depositPeriodFrequency

GetFixedDepositAccountsDepositPeriodFrequency

externalId

String

fieldOfficerId

Integer

int32

id

Integer

int32

interestCalculationDaysInYearType

GetFixedDepositAccountsInterestCalculationDaysInYearType

interestCalculationType

GetFixedDepositAccountsInterestCalculationType

interestCompoundingPeriodType

GetFixedDepositAccountsInterestCompoundingPeriodType

interestFreePeriodApplicable

Boolean

interestPostingPeriodType

GetFixedDepositAccountsInterestPostingPeriodType

maturityAmount

Float

float

maturityDate

date

date

maxDepositTerm

Integer

int32

maxDepositTermType

GetFixedDepositAccountsMaxDepositTermType

minDepositTerm

Integer

int32

minDepositTermType

GetFixedDepositAccountsMinDepositTermType

preClosurePenalApplicable

Boolean

savingsProductId

Integer

int32

savingsProductName

String

status

GetFixedDepositAccountsStatus

summary

GetFixedDepositAccountsAccountIdSummary

timeline

GetFixedDepositAccountsTimeline

.2.235. GetFixedDepositAccountsAccountIdSummary

Field Name Required Type Description Format

accountBalance

Float

float

currency

GetFixedDepositAccountsAccountIdCurrency

.2.236. GetFixedDepositAccountsChartSlabs

Field Name Required Type Description Format

annualInterestRate

Double

double

currency

GetFixedDepositAccountsAccountChartCurrency

fromPeriod

Integer

int32

id

Integer

int32

periodType

GetFixedDepositAccountsPeriodType

toPeriod

Integer

int32

.2.237. GetFixedDepositAccountsCurrency

Field Name Required Type Description Format

code

String

decimalPlaces

Integer

int32

displayLabel

String

displaySymbol

String

inMultiplesOf

Integer

int32

name

String

nameCode

String

.2.238. GetFixedDepositAccountsDepositPeriodFrequency

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.239. GetFixedDepositAccountsInterestCalculationDaysInYearType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.240. GetFixedDepositAccountsInterestCalculationType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.241. GetFixedDepositAccountsInterestCompoundingPeriodType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.242. GetFixedDepositAccountsInterestPostingPeriodType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.243. GetFixedDepositAccountsMaxDepositTermType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.244. GetFixedDepositAccountsMinDepositTermType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.245. GetFixedDepositAccountsPeriodType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.246. GetFixedDepositAccountsPeriodTypes

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.247. GetFixedDepositAccountsProductOptions

Field Name Required Type Description Format

id

Integer

int32

name

String

.2.248. GetFixedDepositAccountsResponse

GetFixedDepositAccountsResponse

Field Name Required Type Description Format

accountNo

Long

int64

clientId

Integer

int32

clientName

String

currency

GetFixedDepositAccountsCurrency

depositAmount

Float

float

depositPeriod

Integer

int32

depositPeriodFrequency

GetFixedDepositAccountsDepositPeriodFrequency

fieldOfficerId

Integer

int32

id

Integer

int32

interestCalculationDaysInYearType

GetFixedDepositAccountsInterestCalculationDaysInYearType

interestCalculationType

GetFixedDepositAccountsInterestCalculationType

interestCompoundingPeriodType

GetFixedDepositAccountsInterestCompoundingPeriodType

interestFreePeriodApplicable

Boolean

interestPostingPeriodType

GetFixedDepositAccountsInterestPostingPeriodType

maturityAmount

Float

float

maturityDate

date

date

maxDepositTerm

Integer

int32

maxDepositTermType

GetFixedDepositAccountsMaxDepositTermType

minDepositTerm

Integer

int32

minDepositTermType

GetFixedDepositAccountsMinDepositTermType

preClosurePenalApplicable

Boolean

savingsProductId

Integer

int32

savingsProductName

String

status

GetFixedDepositAccountsStatus

summary

GetFixedDepositAccountsSummary

timeline

GetFixedDepositAccountsTimeline

.2.249. GetFixedDepositAccountsStatus

Field Name Required Type Description Format

active

Boolean

approved

Boolean

closed

Boolean

code

String

description

String

id

Integer

int32

prematureClosed

Boolean

rejected

Boolean

submittedAndPendingApproval

Boolean

transferInProgress

Boolean

transferOnHold

Boolean

withdrawnByApplicant

Boolean

.2.250. GetFixedDepositAccountsSummary

Field Name Required Type Description Format

accountBalance

Float

float

currency

GetFixedDepositAccountsCurrency

.2.251. GetFixedDepositAccountsTemplateResponse

GetFixedDepositAccountsTemplateResponse

Field Name Required Type Description Format

clientId

Integer

int32

clientName

String

productOptions

Set of Section .2.247

.2.252. GetFixedDepositAccountsTimeline

Field Name Required Type Description Format

submittedByFirstname

String

submittedByLastname

String

submittedByUsername

String

submittedOnDate

date

date

.2.253. GetFixedDepositProductsAccountingRule

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.254. GetFixedDepositProductsCurrency

Field Name Required Type Description Format

code

String

decimalPlaces

Integer

int32

displayLabel

String

displaySymbol

String

inMultiplesOf

Integer

int32

name

String

nameCode

String

.2.255. GetFixedDepositProductsInterestCalculationDaysInYearType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.256. GetFixedDepositProductsInterestCalculationType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.257. GetFixedDepositProductsInterestCompoundingPeriodType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.258. GetFixedDepositProductsInterestPostingPeriodType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.259. GetFixedDepositProductsMaxDepositTermType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.260. GetFixedDepositProductsMinDepositTermType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.261. GetFixedDepositProductsProductIdAccountingMappings

Field Name Required Type Description Format

incomeFromFeeAccount

GetFixedDepositProductsProductIdIncomeFromFeeAccount

incomeFromPenaltyAccount

GetFixedDepositProductsProductIdIncomeFromPenaltyAccount

interestOnSavingsAccount

GetFixedDepositProductsProductIdInterestOnSavingsAccount

savingsControlAccount

GetFixedDepositProductsProductIdSavingsControlAccount

savingsReferenceAccount

GetFixedDepositProductsProductIdSavingsReferenceAccount

transfersInSuspenseAccount

GetFixedDepositProductsProductIdTransfersInSuspenseAccount

.2.262. GetFixedDepositProductsProductIdActiveChart

Field Name Required Type Description Format

chartSlabs

Set of Section .2.263

fromDate

date

date

id

Integer

int32

periodTypes

Set of Section .2.276

savingsProductId

Integer

int32

savingsProductName

String

.2.263. GetFixedDepositProductsProductIdChartSlabs

Field Name Required Type Description Format

annualInterestRate

Double

double

currency

GetFixedDepositProductsProductIdCurrency

description

String

fromPeriod

Integer

int32

id

Integer

int32

periodType

GetFixedDepositProductsProductIdPeriodType

toPeriod

Integer

int32

.2.264. GetFixedDepositProductsProductIdCurrency

Field Name Required Type Description Format

code

String

decimalPlaces

Integer

int32

displayLabel

String

displaySymbol

String

name

String

nameCode

String

.2.265. GetFixedDepositProductsProductIdFeeToIncomeAccountMappings

Field Name Required Type Description Format

charge

GetFixedDepositProductsProductIdFeeToIncomeAccountMappingsCharge

incomeAccount

GetFixedDepositProductsProductIdFeeToIncomeAccountMappingsIncomeAccount

.2.266. GetFixedDepositProductsProductIdFeeToIncomeAccountMappingsCharge

Field Name Required Type Description Format

active

Boolean

id

Integer

int32

name

String

penalty

Boolean

.2.267. GetFixedDepositProductsProductIdFeeToIncomeAccountMappingsIncomeAccount

Field Name Required Type Description Format

glCode

Integer

int32

id

Integer

int32

name

String

.2.268. GetFixedDepositProductsProductIdIncomeFromFeeAccount

Field Name Required Type Description Format

glCode

Integer

int32

id

Integer

int32

name

String

.2.269. GetFixedDepositProductsProductIdIncomeFromPenaltyAccount

Field Name Required Type Description Format

glCode

Integer

int32

id

Integer

int32

name

String

.2.270. GetFixedDepositProductsProductIdInterestCompoundingPeriodType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.271. GetFixedDepositProductsProductIdInterestOnSavingsAccount

Field Name Required Type Description Format

glCode

Integer

int32

id

Integer

int32

name

String

.2.272. GetFixedDepositProductsProductIdMaxDepositTermType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.273. GetFixedDepositProductsProductIdMinDepositTermType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.274. GetFixedDepositProductsProductIdPenaltyToIncomeAccountMappings

Field Name Required Type Description Format

charge

GetFixedDepositProductsProductIdPenaltyToIncomeAccountMappingsCharge

incomeAccount

GetFixedDepositProductsProductIdIncomeFromPenaltyAccount

.2.275. GetFixedDepositProductsProductIdPenaltyToIncomeAccountMappingsCharge

Field Name Required Type Description Format

active

Boolean

id

Integer

int32

name

String

penalty

Boolean

.2.276. GetFixedDepositProductsProductIdPeriodType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.277. GetFixedDepositProductsProductIdPreClosurePenalInterestOnType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.278. GetFixedDepositProductsProductIdResponse

GetFixedDepositProductsProductIdResponse

Field Name Required Type Description Format

accountingMappings

GetFixedDepositProductsProductIdAccountingMappings

activeChart

GetFixedDepositProductsProductIdActiveChart

currency

GetFixedDepositProductsProductIdCurrency

description

String

feeToIncomeAccountMappings

Set of Section .2.265

id

Integer

int32

interestCalculationDaysInYearType

GetFixedDepositProductsInterestCalculationDaysInYearType

interestCalculationType

GetFixedDepositProductsInterestCalculationType

interestCompoundingPeriodType

GetFixedDepositProductsProductIdInterestCompoundingPeriodType

interestPostingPeriodType

GetFixedDepositProductsInterestPostingPeriodType

maxDepositTerm

Integer

int32

maxDepositTermType

GetFixedDepositProductsProductIdMaxDepositTermType

minDepositTerm

Integer

int32

minDepositTermType

GetFixedDepositProductsProductIdMinDepositTermType

name

String

penaltyToIncomeAccountMappings

Set of Section .2.274

preClosurePenalApplicable

Boolean

preClosurePenalInterest

Double

double

preClosurePenalInterestOnType

GetFixedDepositProductsProductIdPreClosurePenalInterestOnType

shortName

String

.2.279. GetFixedDepositProductsProductIdSavingsControlAccount

Field Name Required Type Description Format

glCode

Integer

int32

id

Integer

int32

name

String

.2.280. GetFixedDepositProductsProductIdSavingsReferenceAccount

Field Name Required Type Description Format

glCode

Integer

int32

id

Integer

int32

name

String

.2.281. GetFixedDepositProductsProductIdTransfersInSuspenseAccount

Field Name Required Type Description Format

glCode

Integer

int32

id

Integer

int32

name

String

.2.282. GetFixedDepositProductsResponse

GetFixedDepositProductsResponse

Field Name Required Type Description Format

accountingRule

GetFixedDepositProductsAccountingRule

currency

GetFixedDepositProductsCurrency

description

String

id

Integer

int32

interestCalculationDaysInYearType

GetFixedDepositProductsInterestCalculationDaysInYearType

interestCalculationType

GetFixedDepositProductsInterestCalculationType

interestCompoundingPeriodType

GetFixedDepositProductsInterestCompoundingPeriodType

interestPostingPeriodType

GetFixedDepositProductsInterestPostingPeriodType

maxDepositTerm

Integer

int32

maxDepositTermType

GetFixedDepositProductsMaxDepositTermType

minDepositTerm

Integer

int32

minDepositTermType

GetFixedDepositProductsMinDepositTermType

name

String

nominalAnnualInterestRate

Double

double

preClosurePenalApplicable

Boolean

shortName

String

.2.283. GetFloatingRatesFloatingRateIdResponse

GetFloatingRatesFloatingRateIdResponse

Field Name Required Type Description Format

createdBy

String

createdOn

String

id

Integer

int32

isActive

Boolean

isBaseLendingRate

Boolean

modifiedBy

String

modifiedOn

String

name

String

ratePeriods

Set of Section .2.284

.2.284. GetFloatingRatesRatePeriods

Field Name Required Type Description Format

createdBy

String

createdOn

String

fromDate

String

id

Integer

int32

interestRate

Double

double

isActive

Boolean

isDifferentialToBaseLendingRate

Boolean

modifiedBy

String

modifiedOn

String

.2.285. GetFloatingRatesResponse

GetFloatingRatesResponse

Field Name Required Type Description Format

createdBy

String

createdOn

String

id

Integer

int32

isActive

Boolean

isBaseLendingRate

Boolean

modifiedBy

String

modifiedOn

String

name

String

.2.286. GetFromAccountOptions

Field Name Required Type Description Format

accountId

Integer

int32

accountNo

Integer

int32

accountType

GetAccountOptions

clientId

Integer

int32

clientName

String

officeId

Integer

int32

officeName

String

.2.287. GetFromAccountStandingInstructionSwagger

Field Name Required Type Description Format

accountNo

Long

int64

id

Long

int64

productId

Long

int64

productName

String

.2.288. GetFromAccountTypeOptionsResponseStandingInstructionSwagger

Field Name Required Type Description Format

code

String

description

String

id

Long

int64

.2.289. GetFromAccountTypeResponseStandingInstructionSwagger

Field Name Required Type Description Format

code

String

description

String

id

Long

int64

.2.290. GetFromAccountTypeStandingInstructionSwagger

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.291. GetFromClientOptionsResponseStandingInstructionSwagger

Field Name Required Type Description Format

displayName

String

id

Long

int64

officeId

Long

int64

officeName

String

.2.292. GetFromClientStandingInstructionSwagger

Field Name Required Type Description Format

displayName

String

id

Long

int64

officeId

Long

int64

officeName

String

.2.293. GetFromOfficeOptionsResponseStandingInstructionSwagger

Field Name Required Type Description Format

id

Long

int64

name

String

nameDecorated

String

.2.294. GetFromOfficeResponseStandingInstructionSwagger

Field Name Required Type Description Format

decoratedName

String

externalId

Integer

int32

hierarchy

String

id

Long

int64

name

String

openingDate

date

date

.2.295. GetFromOfficeStandingInstructionSwagger

Field Name Required Type Description Format

id

Long

int64

name

String

.2.296. GetFundsResponse

GetFundsResponse

Field Name Required Type Description Format

id

Integer

int32

name

String

.2.297. GetGLAccountsResponse

GetGLAccountsResponse

Field Name Required Type Description Format

description

String

disabled

Boolean

glCode

String

id

Long

int64

manualEntriesAllowed

Boolean

name

String

nameDecorated

String

organizationRunningBalance

Long

int64

parentId

Long

int64

tagId

CodeValueData

type

EnumOptionData

usage

EnumOptionData

.2.298. GetGLAccountsTemplateResponse

GetGLAccountsTemplateResponse

Field Name Required Type Description Format

accountTypeOptions

List of Section .2.72

allowedAssetsTagOptions

List of Section .2.18

allowedEquityTagOptions

List of Section .2.18

allowedExpensesTagOptions

List of Section .2.18

allowedIncomeTagOptions

List of Section .2.18

allowedLiabilitiesTagOptions

List of Section .2.18

assetHeaderAccountOptions

List of Section .2.84

disabled

Boolean

equityHeaderAccountOptions

List of Section .2.84

expenseHeaderAccountOptions

List of Section .2.84

liabilityHeaderAccountOptions

List of Section .2.84

manualEntriesAllowed

Boolean

type

EnumOptionData

usage

EnumOptionData

usageOptions

List of Section .2.72

.2.299. GetGlClosureResponse

GetGLClosureResponse

Field Name Required Type Description Format

closingDate

date

date

comments

String

createdByUserId

Long

int64

createdByUsername

String

createdDate

date

date

deleted

Boolean

id

Long

int64

lastUpdatedByUserId

Long

int64

lastUpdatedByUsername

String

lastUpdatedDate

date

date

officeId

Long

int64

officeName

String

.2.300. GetGlobalConfigurationsResponse

GetGlobalConfigurationsResponse

Field Name Required Type Description Format

globalConfiguration

List of Section .2.732

.2.301. GetGroupsGroupIdAccountsLoanAccounts

Field Name Required Type Description Format

accountNo

Long

int64

id

Integer

int32

loanType

GetGroupsGroupIdAccountsLoanType

productId

Integer

int32

productName

String

status

GetGroupsGroupIdAccountsStatus

.2.302. GetGroupsGroupIdAccountsLoanType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.303. GetGroupsGroupIdAccountsMemberLoanAccounts

Field Name Required Type Description Format

accountNo

Long

int64

id

Integer

int32

loanType

GetGroupsGroupIdAccountsMemberLoanType

productId

Integer

int32

productName

String

status

GetGroupsGroupIdAccountsMemberLoanStatus

.2.304. GetGroupsGroupIdAccountsMemberLoanStatus

Field Name Required Type Description Format

active

Boolean

closed

Boolean

closedObligationsMet

Boolean

closedRescheduled

Boolean

closedWrittenOff

Boolean

code

String

description

String

id

Integer

int32

overpaid

Boolean

pendingApproval

Boolean

waitingForDisbursal

Boolean

.2.305. GetGroupsGroupIdAccountsMemberLoanType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.306. GetGroupsGroupIdAccountsMemberSavingsAccounts

Field Name Required Type Description Format

accountNo

Long

int64

accountType

GetGroupsGroupIdAccountsMemberLoanType

currency

GetGroupsGroupIdAccountsSavingCurrency

id

Integer

int32

productId

Integer

int32

productName

String

status

GetGroupsGroupIdAccountsSavingStatus

.2.307. GetGroupsGroupIdAccountsResponse

GetGroupsGroupIdAccountsResponse

Field Name Required Type Description Format

loanAccounts

Set of Section .2.301

memberLoanAccounts

Set of Section .2.303

memberSavingsAccounts

Set of Section .2.306

savingsAccounts

Set of Section .2.309

.2.308. GetGroupsGroupIdAccountsSavingAccountType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.309. GetGroupsGroupIdAccountsSavingAccounts

Field Name Required Type Description Format

accountNo

Long

int64

accountType

GetGroupsGroupIdAccountsSavingAccountType

currency

GetGroupsGroupIdAccountsSavingCurrency

id

Integer

int32

productId

Integer

int32

productName

String

status

GetGroupsGroupIdAccountsSavingStatus

.2.310. GetGroupsGroupIdAccountsSavingCurrency

Field Name Required Type Description Format

code

String

decimalPlaces

Integer

int32

displayLabel

String

displaySymbol

String

name

String

nameCode

String

.2.311. GetGroupsGroupIdAccountsSavingStatus

Field Name Required Type Description Format

active

Boolean

approved

Boolean

closed

Boolean

code

String

description

String

id

Integer

int32

rejected

Boolean

submittedAndPendingApproval

Boolean

withdrawnByApplicant

Boolean

.2.312. GetGroupsGroupIdAccountsStatus

Field Name Required Type Description Format

active

Boolean

closed

Boolean

closedObligationsMet

Boolean

closedRescheduled

Boolean

closedWrittenOff

Boolean

code

String

description

String

id

Integer

int32

overpaid

Boolean

pendingApproval

Boolean

waitingForDisbursal

Boolean

.2.313. GetGroupsGroupIdResponse

GetGroupsGroupIdResponse

Field Name Required Type Description Format

externalId

String

hierarchy

String

id

Integer

int32

name

String

officeId

Integer

int32

officeName

String

timeline

GetGroupsGroupIdTimeline

.2.314. GetGroupsGroupIdTimeline

Field Name Required Type Description Format

activatedByFirstname

String

activatedByLastname

String

activatedByUsername

String

activatedOnDate

date

date

.2.315. GetGroupsPageItems

Field Name Required Type Description Format

active

Boolean

hierarchy

String

id

Integer

int32

name

String

officeId

Integer

int32

officeName

String

status

GetGroupsStatus

.2.316. GetGroupsResponse

GetGroupsResponse

Field Name Required Type Description Format

pageItems

Set of Section .2.315

totalFilteredRecords

Integer

int32

.2.317. GetGroupsStatus

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.318. GetGroupsTemplateClientOptions

Field Name Required Type Description Format

displayName

String

id

Integer

int32

officeId

Integer

int32

officeName

String

.2.319. GetGroupsTemplateColumnHeaderData

Field Name Required Type Description Format

columnDisplayType

String

columnLength

Integer

int32

columnName

String

columnType

String

columnValues

Set of [object]

isColumnNullable

Boolean

isColumnPrimaryKey

Boolean

.2.320. GetGroupsTemplateDatatables

Field Name Required Type Description Format

applicationTableName

String

columnHeaderData

Set of Section .2.319

registeredTableName

String

.2.321. GetGroupsTemplateOfficeOptions

Field Name Required Type Description Format

id

Integer

int32

name

String

nameDecorated

String

.2.322. GetGroupsTemplateResponse

GetGroupsTemplateResponse

Field Name Required Type Description Format

clientOptions

Set of Section .2.318

datatables

Set of Section .2.320

officeId

Integer

int32

officeOptions

Set of Section .2.321

staffOptions

Set of Section .2.323

.2.323. GetGroupsTemplateStaffOptions

Field Name Required Type Description Format

displayName

String

id

Integer

int32

.2.324. GetHolidaysResponse

GetHolidaysResponse

Field Name Required Type Description Format

fromDate

date

date

id

Long

int64

name

String

officeId

Long

int64

repaymentsRescheduledTo

date

date

status

EnumOptionData

toDate

date

date

.2.325. GetHookResponse

GetHookResponse

Field Name Required Type Description Format

config

List of Section .2.76

createdAt

date

date

displayName

String

events

List of Section .2.73

id

Long

int64

isActive

Boolean

name

String

templateId

Long

int64

templateName

String

updatedAt

date

date

.2.326. GetHookTemplateResponse

GetHookTemplateResponse

Field Name Required Type Description Format

groupings

List of Section .2.736

templates

List of Section .2.738

.2.327. GetIncomeFromFeeAccountId

Field Name Required Type Description Format

glCode

String

id

Integer

int32

name

String

.2.328. GetIncomeType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.329. GetInstructionTypeOptionsResponseStandingInstructionSwagger

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.330. GetInstructionTypeStandingInstructionSwagger

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.331. GetInterestRateChartsChartIdChartSlabsAttributeName

Field Name Required Type Description Format

code

Integer

int32

description

Integer

int32

id

Integer

int32

.2.332. GetInterestRateChartsChartIdChartSlabsConditionType

Field Name Required Type Description Format

code

Integer

int32

description

Integer

int32

id

Integer

int32

.2.333. GetInterestRateChartsChartIdChartSlabsEntityType

Field Name Required Type Description Format

code

Integer

int32

description

Integer

int32

id

Integer

int32

.2.334. GetInterestRateChartsChartIdChartSlabsIncentiveType

Field Name Required Type Description Format

code

Integer

int32

description

Integer

int32

id

Integer

int32

.2.335. GetInterestRateChartsChartIdChartSlabsIncentives

Field Name Required Type Description Format

amount

Float

float

attributeName

GetInterestRateChartsChartIdChartSlabsAttributeName

attributeValue

Integer

int32

attributeValueDesc

String

conditionType

GetInterestRateChartsChartIdChartSlabsConditionType

entityType

GetInterestRateChartsChartIdChartSlabsEntityType

id

Integer

int32

incentiveType

GetInterestRateChartsChartIdChartSlabsIncentiveType

.2.336. GetInterestRateChartsChartIdChartSlabsResponse

GetInterestRateChartsChartIdChartSlabsResponse

Field Name Required Type Description Format

annualInterestRate

Double

double

currency

GetInterestRateChartsCurrency

description

String

fromPeriod

Integer

int32

id

Integer

int32

incentives

Set of Section .2.335

periodTypes

GetInterestRateChartsTemplatePeriodTypes

toPeriod

Integer

int32

.2.337. GetInterestRateChartsChartSlabs

Field Name Required Type Description Format

annualInterestRate

Integer

int32

currency

GetInterestRateChartsCurrency

fromPeriod

Integer

int32

id

Integer

int32

periodTypes

GetInterestRateChartsTemplatePeriodTypes

.2.338. GetInterestRateChartsCurrency

Field Name Required Type Description Format

code

String

decimalPlaces

Integer

int32

displayLabel

String

displaySymbol

String

name

String

nameCode

String

.2.339. GetInterestRateChartsResponse

GetInterestRateChartsResponse

Field Name Required Type Description Format

chartSlabs

Set of Section .2.337

fromDate

date

date

id

Integer

int32

savingsProductId

Integer

int32

savingsProductName

String

.2.340. GetInterestRateChartsTemplatePeriodTypes

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.341. GetInterestRateChartsTemplateResponse

GetInterestRateChartsTemplateResponse

Field Name Required Type Description Format

periodTypes

Set of Section .2.340

.2.342. GetJobsJobIDJobRunHistoryResponse

GetJobsJobIDJobRunHistoryResponse

Field Name Required Type Description Format

pageItems

List of Section .2.754

totalFilteredRecords

Integer

int32

.2.343. GetJobsResponse

GetJobsResponse

Field Name Required Type Description Format

active

Boolean

cronExpression

String

currentlyRunning

Boolean

displayName

String

initializingError

String

jobId

Long

int64

lastRunHistory

Object

nextRunTime

Date

date-time

.2.344. GetLoanAccountingMappings

Field Name Required Type Description Format

fundSourceAccount

GetLoanFundSourceAccount

incomeFromFeeAccount

GetLoanIncomeFromFeeAccount

incomeFromPenaltyAccount

GetLoanIncomeFromPenaltyAccount

interestOnLoanAccount

GetLoanInterestOnLoanAccount

loanPortfolioAccount

GetLoanPortfolioAccount

overpaymentLiabilityAccount

GetLoanOverpaymentLiabilityAccount

transfersInSuspenseAccount

GetLoanTransfersInSuspenseAccount

writeOffAccount

GetLoanWriteOffAccount

.2.345. GetLoanCharge

Field Name Required Type Description Format

active

Boolean

id

Integer

int32

name

String

penalty

Boolean

.2.346. GetLoanChargeCalculationType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.347. GetLoanChargeCurrency

Field Name Required Type Description Format

code

String

decimalPlaces

Integer

int32

displayLabel

String

displaySymbol

String

name

String

nameCode

String

.2.348. GetLoanChargeTemplateChargeAppliesTo

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.349. GetLoanChargeTemplateChargeOptions

Field Name Required Type Description Format

active

Boolean

amount

Float

float

chargeAppliesTo

GetLoanChargeTemplateChargeAppliesTo

chargeCalculationType

GetLoanChargeCalculationType

chargeTimeType

GetLoanChargeTemplateChargeTimeType

currency

GetLoanChargeCurrency

id

Integer

int32

name

String

penalty

Boolean

.2.350. GetLoanChargeTemplateChargeTimeType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.351. GetLoanChargeTimeType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.352. GetLoanCollateralManagementTemplate

GetLoanCollateralManagementTemplate

Field Name Required Type Description Format

basePrice

BigDecimal

collateralId

Long

int64

name

String

pctToBase

BigDecimal

quantity

BigDecimal

.2.353. GetLoanCurrency

Field Name Required Type Description Format

code

String

decimalPlaces

Integer

int32

displayLabel

String

displaySymbol

String

name

String

nameCode

String

.2.354. GetLoanFeeToIncomeAccountMappings

Field Name Required Type Description Format

charge

GetLoanCharge

incomeAccount

GetLoanIncomeFromFeeAccount

.2.355. GetLoanFundSourceAccount

Field Name Required Type Description Format

glCode

Integer

int32

id

Integer

int32

name

String

.2.356. GetLoanIncomeFromFeeAccount

Field Name Required Type Description Format

glCode

Integer

int32

id

Integer

int32

name

String

.2.357. GetLoanIncomeFromPenaltyAccount

Field Name Required Type Description Format

glCode

Integer

int32

id

Integer

int32

name

String

.2.358. GetLoanInterestOnLoanAccount

Field Name Required Type Description Format

glCode

Integer

int32

id

Integer

int32

name

String

.2.359. GetLoanOverpaymentLiabilityAccount

Field Name Required Type Description Format

glCode

Integer

int32

id

Integer

int32

name

String

.2.360. GetLoanPaymentChannelToFundSourceMappings

Field Name Required Type Description Format

fundSourceAccount

GetLoanFundSourceAccount

paymentType

GetLoanPaymentType

.2.361. GetLoanPaymentType

Field Name Required Type Description Format

id

Integer

int32

name

String

.2.362. GetLoanPortfolioAccount

Field Name Required Type Description Format

glCode

Integer

int32

id

Integer

int32

name

String

.2.363. GetLoanProductsAccountingMappingOptions

Field Name Required Type Description Format

assetAccountOptions

Set of Section .2.366

expenseAccountOptions

Set of Section .2.372

incomeAccountOptions

Set of Section .2.374

liabilityAccountOptions

Set of Section .2.384

.2.364. GetLoanProductsAccountingRule

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.365. GetLoanProductsAmortizationType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.366. GetLoanProductsAssetAccountOptions

Field Name Required Type Description Format

disabled

Boolean

glCode

Integer

int32

id

Integer

int32

manualEntriesAllowed

Boolean

name

String

nameDecorated

String

organizationRunningBalance

Integer

int32

tagId

GetLoanProductsLiabilityTagId

type

GetLoanProductsLiabilityType

usage

GetLoanProductsLiabilityUsage

.2.367. GetLoanProductsChargeAppliesTo

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.368. GetLoanProductsChargeOptions

Field Name Required Type Description Format

active

Boolean

amount

Long

int64

chargeAppliesTo

GetLoanProductsChargeAppliesTo

chargeCalculationType

GetLoanChargeCalculationType

chargePaymentMode

GetLoansChargePaymentMode

chargeTimeType

GetLoanChargeTimeType

currency

GetLoanProductsCurrencyOptions

id

Integer

int32

name

String

penalty

Boolean

.2.369. GetLoanProductsCurrency

Field Name Required Type Description Format

code

String

decimalPlaces

Integer

int32

displayLabel

String

displaySymbol

String

inMultiplesOf

Integer

int32

name

String

nameCode

String

.2.370. GetLoanProductsCurrencyOptions

Field Name Required Type Description Format

code

String

decimalPlaces

Integer

int32

displayLabel

String

displaySymbol

String

name

String

nameCode

String

.2.371. GetLoanProductsDaysInYearTemplateType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.372. GetLoanProductsExpenseAccountOptions

Field Name Required Type Description Format

disabled

Boolean

glCode

Integer

int32

id

Integer

int32

manualEntriesAllowed

Boolean

name

String

nameDecorated

String

organizationRunningBalance

Integer

int32

tagId

GetLoanProductsLiabilityTagId

type

GetLoanProductsExpenseType

usage

GetLoanProductsLiabilityUsage

.2.373. GetLoanProductsExpenseType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.374. GetLoanProductsIncomeAccountOptions

Field Name Required Type Description Format

disabled

Boolean

glCode

Integer

int32

id

Integer

int32

manualEntriesAllowed

Boolean

name

String

nameDecorated

String

organizationRunningBalance

Integer

int32

tagId

GetLoanProductsLiabilityTagId

type

GetLoanProductsIncomeType

usage

GetLoanProductsLiabilityUsage

.2.375. GetLoanProductsIncomeType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.376. GetLoanProductsInterestRateFrequencyType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.377. GetLoanProductsInterestRateTemplateFrequencyType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.378. GetLoanProductsInterestRecalculationCompoundingFrequencyType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.379. GetLoanProductsInterestRecalculationCompoundingType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.380. GetLoanProductsInterestRecalculationData

Field Name Required Type Description Format

id

Integer

int32

interestRecalculationCompoundingFrequencyType

GetLoanProductsInterestRecalculationCompoundingFrequencyType

interestRecalculationCompoundingType

GetLoanProductsInterestRecalculationCompoundingType

isArrearsBasedOnOriginalSchedule

Boolean

preClosureInterestCalculationStrategy

GetLoanProductsPreClosureInterestCalculationStrategy

productId

Integer

int32

recalculationRestFrequencyType

GetLoanProductsInterestRecalculationCompoundingFrequencyType

rescheduleStrategyType

GetLoanProductsRescheduleStrategyType

.2.381. GetLoanProductsInterestRecalculationTemplateData

Field Name Required Type Description Format

interestRecalculationCompoundingType

GetLoanProductsInterestRecalculationCompoundingType

preClosureInterestCalculationStrategy

GetLoanProductsPreClosureInterestCalculationStrategy

rescheduleStrategyType

GetLoanProductsRescheduleStrategyType

.2.382. GetLoanProductsInterestTemplateType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.383. GetLoanProductsInterestType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.384. GetLoanProductsLiabilityAccountOptions

Field Name Required Type Description Format

disabled

Boolean

glCode

Integer

int32

id

Integer

int32

manualEntriesAllowed

Boolean

name

String

nameDecorated

String

organizationRunningBalance

Integer

int32

tagId

GetLoanProductsLiabilityTagId

type

GetLoanProductsLiabilityType

usage

GetLoanProductsLiabilityUsage

.2.385. GetLoanProductsLiabilityTagId

Field Name Required Type Description Format

id

Integer

int32

.2.386. GetLoanProductsLiabilityType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.387. GetLoanProductsLiabilityUsage

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.388. GetLoanProductsParamType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.389. GetLoanProductsPaymentTypeOptions

Field Name Required Type Description Format

id

Integer

int32

name

String

position

Integer

int32

.2.390. GetLoanProductsPreClosureInterestCalculationStrategy

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.391. GetLoanProductsPrincipalVariationsForBorrowerCycle

Field Name Required Type Description Format

borrowerCycleNumber

Integer

int32

defaultValue

Float

float

id

Integer

int32

maxValue

Float

float

minValue

Float

float

paramType

GetLoanProductsParamType

valueConditionType

GetLoanProductsValueConditionType

.2.392. GetLoanProductsProductIdResponse

GetLoanProductsProductIdResponse

Field Name Required Type Description Format

accountingMappings

GetLoanAccountingMappings

accountingRule

GetLoanProductsAccountingRule

amortizationType

GetLoanProductsAmortizationType

annualInterestRate

Float

float

charges

List of [integer]

int32

currency

GetLoanProductsCurrency

feeToIncomeAccountMappings

Set of Section .2.354

fixedPrincipalPercentagePerInstallment

BigDecimal

id

Integer

int32

includeInBorrowerCycle

Boolean

interestCalculationPeriodType

GetLoansProductsInterestCalculationPeriodType

interestRateFrequencyType

GetLoanProductsInterestRateFrequencyType

interestRatePerPeriod

Float

float

interestRateVariationsForBorrowerCycle

List of [integer]

int32

interestType

GetLoanProductsInterestTemplateType

maxPrincipal

Float

float

maxTrancheCount

Integer

int32

minPrincipal

Float

float

multiDisburseLoan

Boolean

name

String

numberOfRepaymentVariationsForBorrowerCycle

List of [integer]

int32

numberOfRepayments

Integer

int32

outstandingLoanBalance

Float

float

overdueDaysForNPA

Integer

int32

paymentChannelToFundSourceMappings

Set of Section .2.360

principal

Float

float

principalThresholdForLastInstalment

Integer

int32

productsPrincipalVariationsForBorrowerCycle

Set of Section .2.391

repaymentEvery

Integer

int32

repaymentFrequencyType

GetLoanProductsRepaymentFrequencyType

shortName

String

status

String

transactionProcessingStrategyId

Integer

int32

transactionProcessingStrategyName

String

useBorrowerCycle

Boolean

.2.393. GetLoanProductsRepaymentFrequencyType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.394. GetLoanProductsRepaymentTemplateFrequencyType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.395. GetLoanProductsRescheduleStrategyType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.396. GetLoanProductsResponse

GetLoanProductsResponse

Field Name Required Type Description Format

accountingRule

GetLoanProductsAccountingRule

amortizationType

GetLoanProductsAmortizationType

annualInterestRate

Float

float

currency

GetLoanProductsCurrency

daysInMonthType

GetLoansProductsDaysInMonthType

daysInYearType

GetLoansProductsDaysInYearType

endDate

date

date

fixedPrincipalPercentagePerInstallment

BigDecimal

id

Integer

int32

includeInBorrowerCycle

Boolean

interestCalculationPeriodType

GetLoansProductsInterestCalculationPeriodType

interestRateFrequencyType

GetLoanProductsInterestRateFrequencyType

interestRatePerPeriod

Float

float

interestRateVariationsForBorrowerCycle

List of [integer]

int32

interestRecalculationData

GetLoanProductsInterestRecalculationData

interestType

GetLoanProductsInterestType

isInterestRecalculationEnabled

Boolean

maxNumberOfRepayments

Integer

int32

maxPrincipal

Float

float

minNumberOfRepayments

Integer

int32

minPrincipal

Float

float

name

String

numberOfRepaymentVariationsForBorrowerCycle

List of [integer]

int32

numberOfRepayments

Integer

int32

principal

Float

float

principalThresholdForLastInstalment

Integer

int32

principalVariationsForBorrowerCycle

List of [integer]

int32

repaymentEvery

Integer

int32

repaymentFrequencyType

GetLoanProductsRepaymentFrequencyType

shortName

String

startDate

date

date

status

String

transactionProcessingStrategyId

Integer

int32

transactionProcessingStrategyName

String

useBorrowerCycle

Boolean

.2.397. GetLoanProductsTemplateCurrency

Field Name Required Type Description Format

code

String

decimalPlaces

Integer

int32

displayLabel

String

displaySymbol

String

inMultiplesOf

Integer

int32

name

String

nameCode

String

.2.398. GetLoanProductsTemplateResponse

GetLoanProductsTemplateResponse

Field Name Required Type Description Format

accountingMappingOptions

GetLoanProductsAccountingMappingOptions

accountingRule

GetLoanProductsAccountingRule

accountingRuleOptions

Set of Section .2.364

amortizationType

GetLoanProductsAmortizationType

amortizationTypeOptions

Set of Section .2.365

chargeOptions

Set of Section .2.368

currency

GetLoanProductsTemplateCurrency

currencyOptions

Set of Section .2.370

daysInMonthType

GetLoansProductsDaysInMonthTemplateType

daysInMonthTypeOptions

Set of Section .2.431

daysInYearType

GetLoanProductsDaysInYearTemplateType

daysInYearTypeOptions

Set of Section .2.382

includeInBorrowerCycle

Boolean

interestCalculationPeriodType

GetLoansProductsInterestCalculationPeriodType

interestCalculationPeriodTypeOptions

Set of Section .2.434

interestRateFrequencyType

GetLoanProductsInterestRateTemplateFrequencyType

interestRateFrequencyTypeOptions

Set of Section .2.377

interestRateVariationsForBorrowerCycle

List of [integer]

int32

interestRecalculationCompoundingTypeOptions

Set of Section .2.379

interestRecalculationData

GetLoanProductsInterestRecalculationTemplateData

interestRecalculationFrequencyTypeOptions

Set of Section .2.378

interestType

GetLoanProductsInterestTemplateType

interestTypeOptions

Set of Section .2.382

isInterestRecalculationEnabled

Boolean

numberOfRepaymentVariationsForBorrowerCycle

List of [integer]

int32

paymentTypeOptions

Set of Section .2.389

preClosureInterestCalculationStrategyOptions

Set of Section .2.390

principalVariationsForBorrowerCycle

List of [integer]

int32

repaymentFrequencyType

GetLoanProductsRepaymentTemplateFrequencyType

repaymentFrequencyTypeOptions

Set of Section .2.394

rescheduleStrategyTypeOptions

Set of Section .2.395

transactionProcessingStrategyOptions

Set of Section .2.399

useBorrowerCycle

Boolean

valueConditionTypeOptions

Set of Section .2.401

.2.399. GetLoanProductsTransactionProcessingStrategyOptions

Field Name Required Type Description Format

code

String

id

Integer

int32

name

String

.2.400. GetLoanProductsValueConditionType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.401. GetLoanProductsValueConditionTypeOptions

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.402. GetLoanTransfersInSuspenseAccount

Field Name Required Type Description Format

glCode

Integer

int32

id

Integer

int32

name

String

.2.403. GetLoanWriteOffAccount

Field Name Required Type Description Format

glCode

Integer

int32

id

Integer

int32

name

String

.2.404. GetLoansChargePaymentMode

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.405. GetLoansCurrency

Field Name Required Type Description Format

code

String

decimalPlaces

Integer

int32

displayLabel

String

displaySymbol

String

name

String

nameCode

String

.2.406. GetLoansLoanIdAmortizationType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.407. GetLoansLoanIdChargeCalculationType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.408. GetLoansLoanIdChargePaymentMode

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.409. GetLoansLoanIdChargeTimeType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.410. GetLoansLoanIdChargesChargeIdResponse

GetLoansLoanIdChargesChargeIdResponse

Field Name Required Type Description Format

amount

Float

float

amountOrPercentage

Float

float

amountOutstanding

Float

float

amountPaid

Float

float

amountPercentageAppliedTo

Double

double

amountWaived

Float

float

amountWrittenOff

Float

float

chargeCalculationType

GetLoanChargeCalculationType

chargeId

Integer

int32

chargeTimeType

GetLoanChargeTimeType

currency

GetLoanChargeCurrency

id

Integer

int32

name

String

penalty

Boolean

percentage

Double

double

.2.411. GetLoansLoanIdChargesTemplateResponse

GetLoansLoanIdChargesTemplateResponse

Field Name Required Type Description Format

amountPaid

Float

float

amountWaived

Float

float

amountWrittenOff

Float

float

chargeOptions

Set of Section .2.349

penalty

Boolean

.2.412. GetLoansLoanIdCollateralsResponse

GetLoansLoanIdCollateralsResponse

Field Name Required Type Description Format

currency

GetCollateralCurrencyResponse

description

String

id

Integer

int32

type

GetCollateralTypeResponse

value

Long

int64

.2.413. GetLoansLoanIdCollateralsTemplateResponse

GetLoansLoanIdCollateralsTemplateResponse

Field Name Required Type Description Format

allowedCollateralTypes

Set of Section .2.221

.2.414. GetLoansLoanIdCurrency

Field Name Required Type Description Format

code

String

decimalPlaces

Integer

int32

displayLabel

String

displaySymbol

String

name

String

nameCode

String

.2.415. GetLoansLoanIdDisbursementDetails

Field Name Required Type Description Format

approvedPrincipal

Float

float

expectedDisbursementDate

date

date

id

Integer

int32

principal

Float

float

.2.416. GetLoansLoanIdFeeFrequency

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.417. GetLoansLoanIdInterestCalculationPeriodType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.418. GetLoansLoanIdInterestRateFrequencyType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.419. GetLoansLoanIdInterestType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.420. GetLoansLoanIdLinkedAccount

Field Name Required Type Description Format

accountNo

Long

int64

id

Integer

int32

.2.421. GetLoansLoanIdLoanType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.422. GetLoansLoanIdOverdueCharges

Field Name Required Type Description Format

active

Boolean

amount

Float

float

chargeAppliesTo

GetLoanChargeTemplateChargeAppliesTo

chargeCalculationType

GetLoansLoanIdChargeCalculationType

chargePaymentMode

GetLoansLoanIdChargePaymentMode

chargeTimeType

GetLoansLoanIdChargeTimeType

currency

GetLoanCurrency

feeFrequency

GetLoansLoanIdFeeFrequency

feeInterval

Integer

int32

id

Integer

int32

name

String

penalty

Boolean

.2.423. GetLoansLoanIdRepaymentFrequencyType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.424. GetLoansLoanIdResponse

GetLoansLoanIdResponse

Field Name Required Type Description Format

accountNo

Long

int64

amortizationType

GetLoansLoanIdAmortizationType

annualInterestRate

Integer

int32

clientId

Integer

int32

clientName

String

clientOfficeId

Integer

int32

currency

GetLoansLoanIdCurrency

fixedPrincipalPercentagePerInstallment

BigDecimal

id

Long

int64

interestCalculationPeriodType

GetLoansLoanIdInterestCalculationPeriodType

interestRateFrequencyType

GetLoansLoanIdInterestRateFrequencyType

interestRatePerPeriod

Integer

int32

interestType

GetLoansLoanIdInterestType

loanOfficerId

Integer

int32

loanOfficerName

String

loanProductDescription

String

loanProductId

Integer

int32

loanProductName

String

loanPurposeId

Integer

int32

loanPurposeName

String

loanType

GetLoansLoanIdLoanType

numberOfRepayments

Integer

int32

principal

Long

int64

repaymentEvery

Integer

int32

repaymentFrequencyType

GetLoansLoanIdRepaymentFrequencyType

status

GetLoansLoanIdStatus

summary

GetLoansLoanIdSummary

termFrequency

Integer

int32

termPeriodFrequencyType

GetLoansLoanIdTermPeriodFrequencyType

timeline

GetLoansLoanIdTimeline

transactionProcessingStrategyId

Integer

int32

.2.425. GetLoansLoanIdStatus

Field Name Required Type Description Format

active

Boolean

closed

Boolean

closedObligationsMet

Boolean

closedRescheduled

Boolean

closedWrittenOff

Boolean

code

String

description

String

id

Integer

int32

overpaid

Boolean

pendingApproval

Boolean

waitingForDisbursal

Boolean

.2.426. GetLoansLoanIdSummary

Field Name Required Type Description Format

canDisburse

Boolean

currency

GetLoansLoanIdCurrency

disbursementDetails

Set of Section .2.415

emiAmountVariations

Set of [object]

feeChargesCharged

Long

int64

feeChargesDueAtDisbursementCharged

Long

int64

feeChargesOutstanding

Long

int64

feeChargesOverdue

Long

int64

feeChargesPaid

Long

int64

feeChargesWaived

Long

int64

feeChargesWrittenOff

Long

int64

fixedEmiAmount

Float

float

inArrears

Boolean

interestCharged

Long

int64

interestOutstanding

Long

int64

interestOverdue

Long

int64

interestPaid

Long

int64

interestWaived

Long

int64

interestWrittenOff

Long

int64

isNPA

Boolean

linkedAccount

GetLoansLoanIdLinkedAccount

maxOutstandingLoanBalance

Long

int64

overdueCharges

Set of Section .2.422

overdueSinceDate

date

date

penaltyChargesCharged

Long

int64

penaltyChargesOutstanding

Long

int64

penaltyChargesOverdue

Long

int64

penaltyChargesPaid

Long

int64

penaltyChargesWaived

Long

int64

penaltyChargesWrittenOff

Long

int64

principalDisbursed

Long

int64

principalOutstanding

Long

int64

principalOverdue

Double

double

principalPaid

Long

int64

principalWrittenOff

Long

int64

totalCostOfLoan

Long

int64

totalExpectedCostOfLoan

Long

int64

totalExpectedRepayment

Long

int64

totalOutstanding

Long

int64

totalOverdue

Double

double

totalRepayment

Long

int64

totalWaived

Long

int64

totalWrittenOff

Long

int64

.2.427. GetLoansLoanIdTermPeriodFrequencyType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.428. GetLoansLoanIdTimeline

Field Name Required Type Description Format

actualDisbursementDate

date

date

approvedByFirstname

String

approvedByLastname

String

approvedByUsername

String

approvedOnDate

date

date

disbursedByFirstname

String

disbursedByLastname

String

disbursedByUsername

String

expectedDisbursementDate

date

date

expectedMaturityDate

date

date

submittedByFirstname

String

submittedByLastname

String

submittedByUsername

String

submittedOnDate

date

date

.2.429. GetLoansLoanIdTransactionsTemplateResponse

GetLoansLoanIdTransactionsTemplateResponse

Field Name Required Type Description Format

date

date

date

total

GetLoansTotal

transactionType

GetLoansTransactionType

.2.430. GetLoansLoanIdTransactionsTransactionIdResponse

GetLoansLoanIdTransactionsTransactionIdResponse

Field Name Required Type Description Format

amount

Double

double

currency

GetLoansCurrency

date

date

date

id

Integer

int32

interestPortion

Double

double

manuallyReversed

Boolean

type

GetLoansType

.2.431. GetLoansProductsDaysInMonthTemplateType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.432. GetLoansProductsDaysInMonthType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.433. GetLoansProductsDaysInYearType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.434. GetLoansProductsInterestCalculationPeriodType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.435. GetLoansResponse

GetLoansResponse

Field Name Required Type Description Format

pageItems

Set of Section .2.424

totalFilteredRecords

Integer

int32

.2.436. GetLoansTemplateProductOptions

Field Name Required Type Description Format

id

Integer

int32

name

String

.2.437. GetLoansTemplateResponse

GetLoansTemplateResponse

Field Name Required Type Description Format

clientId

Long

int64

clientName

String

clientOfficeId

Integer

int32

productOptions

Set of Section .2.436

timeline

GetLoansTemplateTimeline

.2.438. GetLoansTemplateTimeline

Field Name Required Type Description Format

expectedDisbursementDate

date

date

.2.439. GetLoansTotal

Field Name Required Type Description Format

amount

Float

float

currencyCode

String

defaultName

String

digitsAfterDecimal

Integer

int32

displaySymbol

String

displaySymbolValue

String

greaterThanZero

Boolean

inMultiplesOf

Integer

int32

nameCode

String

zero

Boolean

.2.440. GetLoansTransactionType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.441. GetLoansType

Field Name Required Type Description Format

code

String

contra

Boolean

description

String

disbursement

Boolean

id

Integer

int32

recoveryRepayment

Boolean

repayment

Boolean

repaymentAtDisbursement

Boolean

waiveCharges

Boolean

waiveInterest

Boolean

writeOff

Boolean

.2.442. GetLockPeriodTypeEnum

Field Name Required Type Description Format

description

String

id

Integer

int32

.2.443. GetMakerCheckerResponse

GetMakerCheckerResponse

Field Name Required Type Description Format

actionName

String

checkedOnDate

Date

date-time

checker

String

clientId

Long

int64

clientName

String

commandAsJson

String

entityName

String

groupLevelName

String

groupName

String

id

Long

int64

loanAccountNo

String

loanId

Long

int64

madeOnDate

Date

date-time

maker

String

officeName

String

processingResult

String

resourceId

Long

int64

savingsAccountNo

String

subresourceId

Long

int64

url

String

.2.444. GetMakerCheckersSearchTemplateResponse

GetMakerCheckersSearchTemplateResponse

Field Name Required Type Description Format

actionNames

List of [string]

appUsers

List of Section .2.5

entityNames

List of [string]

processingResults

List of Section .2.984

.2.445. GetNotesNoteType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.446. GetOfficesResponse

GetOfficesResponse

Field Name Required Type Description Format

externalId

String

hierarchy

String

id

Long

int64

name

String

nameDecorated

String

openingDate

date

date

.2.447. GetOfficesTemplateResponse

GetOfficesTemplateResponse

Field Name Required Type Description Format

allowedParents

List of Section .2.446

openingDate

date

date

.2.448. GetPageItemsStandingInstructionSwagger

Field Name Required Type Description Format

accountDetailId

Long

int64

amount

Float

float

fromAccount

GetFromAccountStandingInstructionSwagger

fromAccountType

GetFromAccountTypeStandingInstructionSwagger

fromClient

GetFromClientStandingInstructionSwagger

fromOffice

GetFromOfficeStandingInstructionSwagger

id

Long

int64

instructionType

GetInstructionTypeStandingInstructionSwagger

name

String

priority

GetPriorityStandingInstructionSwagger

recurrenceFrequency

GetRecurrenceFrequencyStandingInstructionSwagger

recurrenceInterval

Integer

int32

recurrenceOnMonthDay

date

date

recurrenceType

GetRecurrenceTypeStandingInstructionSwagger

status

GetStatusStandingInstructionSwagger

toAccount

GetToAccountStandingInstructionSwagger

toAccountType

GetToAccountTypeStandingInstructionSwagger

toClient

GetToClientStandingInstructionSwagger

toOffice

GetToOfficeStandingInstructionSwagger

transferType

GetTransferTypeStandingInstructionSwagger

validFrom

date

date

.2.449. GetPasswordPreferencesTemplateResponse

GetPasswordPreferencesTemplateResponse

Field Name Required Type Description Format

active

Boolean

description

String

id

Long

int64

key

String

.2.450. GetPaymentTypesPaymentTypeIdResponse

GetPaymentTypesPaymentTypeIdResponse

Field Name Required Type Description Format

description

String

id

Integer

int32

isCashPayment

Boolean

name

String

position

Integer

int32

.2.451. GetPaymentTypesResponse

GetPaymentTypesResponse

Field Name Required Type Description Format

description

String

id

Integer

int32

isCashPayment

Boolean

name

String

position

Integer

int32

.2.452. GetPermissionsResponse

GetPermissionsResponse

Field Name Required Type Description Format

actionName

String

code

String

entityName

String

grouping

String

selected

Boolean

.2.453. GetPocketData

Field Name Required Type Description Format

row

String

.2.454. GetPocketLoanAccounts

Field Name Required Type Description Format

accountId

Integer

int32

accountNumber

Integer

int32

accountType

Integer

int32

id

Integer

int32

pocketId

Integer

int32

.2.455. GetPocketSavingAccounts

Field Name Required Type Description Format

accountId

Integer

int32

accountNumber

Integer

int32

accountType

Integer

int32

id

Integer

int32

pocketId

Integer

int32

.2.456. GetPostDatedChecks

GetPostDatedChecks

Field Name Required Type Description Format

accountNo

Long

int64

amount

BigDecimal

date

date

date

id

Long

int64

installmentId

Integer

int32

name

String

.2.457. GetPriorityOptionsResponseStandingInstructionSwagger

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.458. GetPriorityStandingInstructionSwagger

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.459. GetProductsAccountingMappingOptions

Field Name Required Type Description Format

assetAccountOptions

Set of Section .2.462

equityAccountOptions

Set of Section .2.465

incomeAccountOptions

Set of Section .2.466

liabilityAccountOptions

Set of Section .2.467

.2.460. GetProductsAccountingMappings

Field Name Required Type Description Format

incomeFromFeeAccountId

GetIncomeFromFeeAccountId

shareEquityId

GetShareEquityId

shareReferenceId

GetShareReferenceId

shareSuspenseId

GetShareSuspenseId

.2.461. GetProductsAccountingRule

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.462. GetProductsAssetAccountOptions

Field Name Required Type Description Format

description

String

disabled

Boolean

glCode

String

id

Integer

int32

manualEntriesAllowed

Boolean

name

String

nameDecorated

String

tagId

GetProductsTagId

type

GetAssetType

usage

GetProductsLiabilityUsage

.2.463. GetProductsCharges

Field Name Required Type Description Format

active

Boolean

amount

Integer

int32

chargeAppliesTo

GetChargeAppliesTo

chargeCalculationType

GetChargeCalculationType

chargePaymentMode

GetChargePaymentMode

chargeTimeType

GetChargeTimeType

currency

GetChargesCurrency

id

Integer

int32

name

String

penalty

Boolean

.2.464. GetProductsCurrency

Field Name Required Type Description Format

code

String

decimalPlaces

Integer

int32

displayLabel

String

displaySymbol

String

inMultiplesOf

Integer

int32

name

String

nameCode

String

.2.465. GetProductsEquityAccountOptions

Field Name Required Type Description Format

disabled

Boolean

glCode

String

id

Integer

int32

manualEntriesAllowed

Boolean

name

String

nameDecorated

String

tagId

GetProductsTagId

type

GetEquityType

usage

GetProductsLiabilityUsage

.2.466. GetProductsIncomeAccountOptions

Field Name Required Type Description Format

description

String

disabled

Boolean

glCode

String

id

Integer

int32

manualEntriesAllowed

Boolean

name

String

nameDecorated

String

tagId

GetProductsTagId

type

GetIncomeType

usage

GetProductsLiabilityUsage

.2.467. GetProductsLiabilityAccountOptions

Field Name Required Type Description Format

description

String

disabled

Boolean

glCode

String

id

Integer

int32

manualEntriesAllowed

Boolean

name

String

nameDecorated

String

tagId

GetProductsTagId

type

GetProductsLiabilityType

usage

GetProductsLiabilityUsage

.2.468. GetProductsLiabilityType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.469. GetProductsLiabilityUsage

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.470. GetProductsMarketPrice

Field Name Required Type Description Format

fromDate

String

id

Integer

int32

shareValue

Integer

int32

.2.471. GetProductsMinimumActivePeriodFrequencyTypeOptions

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.472. GetProductsPageItems

Field Name Required Type Description Format

id

Integer

int32

name

String

shortName

String

totalShares

Integer

int32

.2.473. GetProductsTagId

Field Name Required Type Description Format

id

Integer

int32

isActive

Boolean

.2.474. GetProductsTypeProductIdResponse

GetProductsTypeProductIdResponse

Field Name Required Type Description Format

accountingMappingOptions

GetProductsAccountingMappingOptions

accountingMappings

GetProductsAccountingMappings

accountingRule

GetProductsAccountingRule

allowDividendCalculationForInactiveClients

Boolean

chargeOptions

Set of Section .2.463

charges

Set of Section .2.463

currency

GetProductsCurrency

currencyOptions

Set of Section .2.165

description

String

id

Integer

int32

lockPeriodTypeEnum

GetLockPeriodTypeEnum

lockinPeriod

Integer

int32

lockinPeriodFrequencyTypeOptions

Set of Section .2.471

marketPrice

Set of Section .2.470

maximumShares

Integer

int32

minimumActivePeriod

Integer

int32

minimumActivePeriodForDividendsTypeEnum

GetLockPeriodTypeEnum

minimumActivePeriodFrequencyTypeOptions

Set of Section .2.471

minimumShares

Integer

int32

name

String

nominalShares

Integer

int32

shareCapital

Integer

int32

shortName

String

totalShares

Integer

int32

totalSharesIssued

Integer

int32

unitPrice

Integer

int32

.2.475. GetProductsTypeResponse

GetProductsTypeResponse

Field Name Required Type Description Format

pageItems

Set of Section .2.472

totalFilteredRecords

Integer

int32

.2.476. GetProvisioningCriteriaCriteriaIdResponse

GetProvisioningCriteriaCriteriaIdResponse

Field Name Required Type Description Format

createdBy

String

criteriaId

Long

int64

criteriaName

String

loanProducts

List of Section .2.760

provisioningcriteria

List of Section .2.985

.2.477. GetProvisioningCriteriaResponse

GetProvisioningCriteriaResponse

Field Name Required Type Description Format

createdBy

String

criteriaId

Long

int64

criteriaName

String

.2.478. GetRecurrenceFrequencyOptionsResponseStandingInstructionSwagger

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.479. GetRecurrenceFrequencyStandingInstructionSwagger

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.480. GetRecurrenceTypeOptionsResponseStandingInstructionSwagger

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.481. GetRecurrenceTypeStandingInstructionSwagger

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.482. GetRecurringCurrency

Field Name Required Type Description Format

code

String

decimalPlaces

Integer

int32

displayLabel

String

displaySymbol

String

inMultiplesOf

Integer

int32

name

String

nameCode

String

.2.483. GetRecurringDepositAccountsAccountChart

Field Name Required Type Description Format

accountId

Integer

int32

accountNumber

Long

int64

chartSlabs

Set of Section .2.486

fromDate

date

date

id

Integer

int32

periodTypes

Set of Section .2.496

.2.484. GetRecurringDepositAccountsAccountChartCurrency

Field Name Required Type Description Format

code

String

decimalPlaces

Integer

int32

displayLabel

String

displaySymbol

String

name

String

nameCode

String

.2.485. GetRecurringDepositAccountsAccountIdResponse

GetRecurringDepositAccountsAccountIdResponse

Field Name Required Type Description Format

accountChart

GetRecurringDepositAccountsAccountChart

accountNo

Long

int64

clientId

Integer

int32

clientName

String

currency

GetRecurringDepositAccountsCurrency

depositPeriod

Integer

int32

depositPeriodFrequency

GetRecurringDepositAccountsDepositPeriodFrequency

expectedFirstDepositOnDate

date

date

externalId

String

fieldOfficerId

Integer

int32

id

Integer

int32

interestCalculationDaysInYearType

GetRecurringDepositAccountsInterestCalculationDaysInYearType

interestCalculationType

GetRecurringDepositAccountsInterestCalculationType

interestCompoundingPeriodType

GetRecurringDepositAccountsInterestCompoundingPeriodType

interestPostingPeriodType

GetRecurringDepositAccountsInterestPostingPeriodType

maxDepositTerm

Integer

int32

maxDepositTermType

GetRecurringDepositAccountsMaxDepositTermType

minDepositTerm

Integer

int32

minDepositTermType

GetRecurringDepositAccountsMinDepositTermType

preClosurePenalApplicable

Boolean

recurringDepositAmount

Integer

int32

recurringDepositFrequency

Integer

int32

recurringDepositFrequencyType

GetRecurringDepositAccountsRecurringDepositFrequencyType

savingsProductId

Integer

int32

savingsProductName

String

status

GetRecurringDepositAccountsStatus

summary

GetRecurringDepositAccountsSummary

timeline

GetRecurringDepositAccountsTimeline

.2.486. GetRecurringDepositAccountsChartSlabs

Field Name Required Type Description Format

annualInterestRate

Double

double

currency

GetRecurringDepositAccountsAccountChartCurrency

fromPeriod

Integer

int32

id

Integer

int32

periodType

GetRecurringDepositAccountsPeriodType

toPeriod

Integer

int32

.2.487. GetRecurringDepositAccountsCurrency

Field Name Required Type Description Format

code

String

decimalPlaces

Integer

int32

displayLabel

String

displaySymbol

String

inMultiplesOf

Integer

int32

name

String

nameCode

String

.2.488. GetRecurringDepositAccountsDepositPeriodFrequency

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.489. GetRecurringDepositAccountsInterestCalculationDaysInYearType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.490. GetRecurringDepositAccountsInterestCalculationType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.491. GetRecurringDepositAccountsInterestCompoundingPeriodType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.492. GetRecurringDepositAccountsInterestPostingPeriodType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.493. GetRecurringDepositAccountsMaxDepositTermType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.494. GetRecurringDepositAccountsMinDepositTermType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.495. GetRecurringDepositAccountsPeriodType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.496. GetRecurringDepositAccountsPeriodTypes

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.497. GetRecurringDepositAccountsRecurringDepositAccountIdTransactionsTemplateResponse

GetRecurringDepositAccountsRecurringDepositAccountIdTransactionsTemplateResponse

Field Name Required Type Description Format

accountId

Integer

int32

accountNo

String

amount

BigDecimal

currency

GetRecurringCurrency

date

date

date

id

Integer

int32

paymentTypeOptions

List of [integer]

int32

reversed

Boolean

transactionType

GetRecurringTransactionType

.2.498. GetRecurringDepositAccountsRecurringDepositAccountIdTransactionsTransactionIdResponse

GetRecurringDepositAccountsRecurringDepositAccountIdTransactionsTransactionIdResponse

Field Name Required Type Description Format

accountId

Integer

int32

accountNo

String

amount

Float

float

currency

GetRecurringTransactionsCurrency

date

date

date

id

Integer

int32

paymentDetailData

GetRecurringPaymentDetailData

reversed

Boolean

runningBalance

Integer

int32

transactionType

GetRecurringTransactionsTransactionType

.2.499. GetRecurringDepositAccountsRecurringDepositFrequencyType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.500. GetRecurringDepositAccountsResponse

GetRecurringDepositAccountsResponse

Field Name Required Type Description Format

accountNo

Long

int64

clientId

Integer

int32

clientName

String

currency

GetRecurringDepositAccountsCurrency

depositAmount

Float

float

depositPeriod

Integer

int32

depositPeriodFrequency

GetRecurringDepositAccountsDepositPeriodFrequency

fieldOfficerId

Integer

int32

id

Integer

int32

interestCalculationDaysInYearType

GetRecurringDepositAccountsInterestCalculationDaysInYearType

interestCalculationType

GetRecurringDepositAccountsInterestCalculationType

interestCompoundingPeriodType

GetRecurringDepositAccountsInterestCompoundingPeriodType

interestPostingPeriodType

GetRecurringDepositAccountsInterestPostingPeriodType

maturityAmount

Float

float

maturityDate

date

date

maxDepositTerm

Integer

int32

maxDepositTermType

GetRecurringDepositAccountsMaxDepositTermType

minDepositTerm

Integer

int32

minDepositTermType

GetRecurringDepositAccountsMinDepositTermType

preClosurePenalApplicable

Boolean

recurringDepositAmount

Integer

int32

recurringDepositFrequency

Integer

int32

recurringDepositFrequencyType

GetRecurringDepositAccountsRecurringDepositFrequencyType

savingsProductId

Integer

int32

savingsProductName

String

status

GetRecurringDepositAccountsStatus

summary

GetRecurringDepositAccountsSummary

timeline

GetRecurringDepositAccountsTimeline

.2.501. GetRecurringDepositAccountsStatus

Field Name Required Type Description Format

active

Boolean

approved

Boolean

closed

Boolean

code

String

description

String

id

Integer

int32

prematureClosed

Boolean

rejected

Boolean

submittedAndPendingApproval

Boolean

transferInProgress

Boolean

transferOnHold

Boolean

withdrawnByApplicant

Boolean

.2.502. GetRecurringDepositAccountsSummary

Field Name Required Type Description Format

accountBalance

Float

float

currency

GetRecurringDepositAccountsCurrency

.2.503. GetRecurringDepositAccountsTemplateResponse

GetRecurringDepositAccountsTemplateResponse

Field Name Required Type Description Format

clientId

Integer

int32

clientName

String

productOptions

Set of Section .2.538

.2.504. GetRecurringDepositAccountsTimeline

Field Name Required Type Description Format

submittedByFirstname

String

submittedByLastname

String

submittedByUsername

String

submittedOnDate

date

date

.2.505. GetRecurringDepositProductsAccountingRule

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.506. GetRecurringDepositProductsCurrency

Field Name Required Type Description Format

code

String

decimalPlaces

Integer

int32

displayLabel

String

displaySymbol

String

inMultiplesOf

Integer

int32

name

String

nameCode

String

.2.507. GetRecurringDepositProductsInterestCalculationDaysInYearType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.508. GetRecurringDepositProductsInterestCalculationType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.509. GetRecurringDepositProductsInterestCompoundingPeriodType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.510. GetRecurringDepositProductsInterestPostingPeriodType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.511. GetRecurringDepositProductsMaxDepositTermType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.512. GetRecurringDepositProductsMinDepositTermType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.513. GetRecurringDepositProductsProductIdAccountingMappings

Field Name Required Type Description Format

incomeFromFeeAccount

GetRecurringDepositProductsProductIdIncomeFromFeeAccount

incomeFromPenaltyAccount

GetRecurringDepositProductsProductIdIncomeFromPenaltyAccount

interestOnSavingsAccount

GetRecurringDepositProductsProductIdInterestOnSavingsAccount

savingsControlAccount

GetRecurringDepositProductsProductIdSavingsControlAccount

savingsReferenceAccount

GetRecurringDepositProductsProductIdSavingsReferenceAccount

transfersInSuspenseAccount

GetRecurringDepositProductsProductIdTransfersInSuspenseAccount

.2.514. GetRecurringDepositProductsProductIdActiveChart

Field Name Required Type Description Format

chartSlabs

Set of Section .2.515

fromDate

date

date

id

Integer

int32

periodTypes

Set of Section .2.528

savingsProductId

Integer

int32

savingsProductName

String

.2.515. GetRecurringDepositProductsProductIdChartSlabs

Field Name Required Type Description Format

annualInterestRate

Double

double

currency

GetRecurringDepositProductsProductIdCurrency

description

String

fromPeriod

Integer

int32

id

Integer

int32

periodType

GetRecurringDepositProductsProductIdPeriodType

toPeriod

Integer

int32

.2.516. GetRecurringDepositProductsProductIdCurrency

Field Name Required Type Description Format

code

String

decimalPlaces

Integer

int32

displayLabel

String

displaySymbol

String

name

String

nameCode

String

.2.517. GetRecurringDepositProductsProductIdFeeToIncomeAccountMappings

Field Name Required Type Description Format

charge

GetRecurringDepositProductsProductIdFeeToIncomeAccountMappingsCharge

incomeAccount

GetRecurringDepositProductsProductIdFeeToIncomeAccountMappingsIncomeAccount

.2.518. GetRecurringDepositProductsProductIdFeeToIncomeAccountMappingsCharge

Field Name Required Type Description Format

active

Boolean

id

Integer

int32

name

String

penalty

Boolean

.2.519. GetRecurringDepositProductsProductIdFeeToIncomeAccountMappingsIncomeAccount

Field Name Required Type Description Format

glCode

Integer

int32

id

Integer

int32

name

String

.2.520. GetRecurringDepositProductsProductIdIncomeFromFeeAccount

Field Name Required Type Description Format

glCode

Integer

int32

id

Integer

int32

name

String

.2.521. GetRecurringDepositProductsProductIdIncomeFromPenaltyAccount

Field Name Required Type Description Format

glCode

Integer

int32

id

Integer

int32

name

String

.2.522. GetRecurringDepositProductsProductIdInterestCompoundingPeriodType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.523. GetRecurringDepositProductsProductIdInterestOnSavingsAccount

Field Name Required Type Description Format

glCode

Integer

int32

id

Integer

int32

name

String

.2.524. GetRecurringDepositProductsProductIdMaxDepositTermType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.525. GetRecurringDepositProductsProductIdMinDepositTermType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.526. GetRecurringDepositProductsProductIdPenaltyToIncomeAccountMappings

Field Name Required Type Description Format

charge

GetRecurringDepositProductsProductIdPenaltyToIncomeAccountMappingsCharge

incomeAccount

GetRecurringDepositProductsProductIdIncomeFromPenaltyAccount

.2.527. GetRecurringDepositProductsProductIdPenaltyToIncomeAccountMappingsCharge

Field Name Required Type Description Format

active

Boolean

id

Integer

int32

name

String

penalty

Boolean

.2.528. GetRecurringDepositProductsProductIdPeriodType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.529. GetRecurringDepositProductsProductIdPreClosurePenalInterestOnType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.530. GetRecurringDepositProductsProductIdResponse

GetRecurringDepositProductsProductIdResponse

Field Name Required Type Description Format

accountingMappings

GetRecurringDepositProductsProductIdAccountingMappings

activeChart

GetRecurringDepositProductsProductIdActiveChart

currency

GetRecurringDepositProductsProductIdCurrency

description

String

feeToIncomeAccountMappings

Set of Section .2.517

id

Integer

int32

interestCalculationDaysInYearType

GetRecurringDepositProductsInterestCalculationDaysInYearType

interestCalculationType

GetRecurringDepositProductsInterestCalculationType

interestCompoundingPeriodType

GetRecurringDepositProductsProductIdInterestCompoundingPeriodType

interestPostingPeriodType

GetRecurringDepositProductsInterestPostingPeriodType

maxDepositTerm

Integer

int32

maxDepositTermType

GetRecurringDepositProductsProductIdMaxDepositTermType

minDepositTerm

Integer

int32

minDepositTermType

GetRecurringDepositProductsProductIdMinDepositTermType

name

String

penaltyToIncomeAccountMappings

Set of Section .2.526

preClosurePenalApplicable

Boolean

preClosurePenalInterest

Double

double

preClosurePenalInterestOnType

GetRecurringDepositProductsProductIdPreClosurePenalInterestOnType

recurringDepositFrequency

Integer

int32

recurringDepositFrequencyType

GetRecurringDepositProductsRecurringDepositFrequencyType

shortName

String

.2.531. GetRecurringDepositProductsProductIdSavingsControlAccount

Field Name Required Type Description Format

glCode

Integer

int32

id

Integer

int32

name

String

.2.532. GetRecurringDepositProductsProductIdSavingsReferenceAccount

Field Name Required Type Description Format

glCode

Integer

int32

id

Integer

int32

name

String

.2.533. GetRecurringDepositProductsProductIdTransfersInSuspenseAccount

Field Name Required Type Description Format

glCode

Integer

int32

id

Integer

int32

name

String

.2.534. GetRecurringDepositProductsRecurringDepositFrequencyType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.535. GetRecurringDepositProductsResponse

GetRecurringDepositProductsResponse

Field Name Required Type Description Format

accountingRule

GetRecurringDepositProductsAccountingRule

currency

GetRecurringDepositProductsCurrency

description

String

id

Integer

int32

interestCalculationDaysInYearType

GetRecurringDepositProductsInterestCalculationDaysInYearType

interestCalculationType

GetRecurringDepositProductsInterestCalculationType

interestCompoundingPeriodType

GetRecurringDepositProductsInterestCompoundingPeriodType

interestPostingPeriodType

GetRecurringDepositProductsInterestPostingPeriodType

maxDepositTerm

Integer

int32

maxDepositTermType

GetRecurringDepositProductsMaxDepositTermType

minDepositTerm

Integer

int32

minDepositTermType

GetRecurringDepositProductsMinDepositTermType

name

String

nominalAnnualInterestRate

Double

double

preClosurePenalApplicable

Boolean

recurringDepositFrequency

Integer

int32

recurringDepositFrequencyType

GetRecurringDepositProductsRecurringDepositFrequencyType

shortName

String

.2.536. GetRecurringPaymentDetailData

Field Name Required Type Description Format

accountNumber

Integer

int32

bankNumber

Integer

int32

checkNumber

Integer

int32

id

Integer

int32

paymentType

GetRecurringPaymentType

receiptNumber

Integer

int32

routingCode

Integer

int32

.2.537. GetRecurringPaymentType

Field Name Required Type Description Format

id

Integer

int32

name

String

.2.538. GetRecurringProductOptions

Field Name Required Type Description Format

id

Integer

int32

name

String

.2.539. GetRecurringTransactionType

Field Name Required Type Description Format

approveTransfer

Boolean

code

String

deposit

Boolean

description

String

feeDeduction

Boolean

id

Integer

int32

initiateTransfer

Boolean

interestPosting

Boolean

overdraftFee

Boolean

overdraftInterest

Boolean

rejectTransfer

Boolean

withdrawTransfer

Boolean

withdrawal

Boolean

writtenoff

Boolean

.2.540. GetRecurringTransactionsCurrency

Field Name Required Type Description Format

code

String

decimalPlaces

Integer

int32

displayLabel

String

displaySymbol

String

inMultiplesOf

Integer

int32

name

String

nameCode

String

.2.541. GetRecurringTransactionsTransactionType

Field Name Required Type Description Format

code

String

deposit

Boolean

description

String

feeDeduction

Boolean

id

Integer

int32

interestPosting

Boolean

withdrawal

Boolean

.2.542. GetReportMailingJobsResponse

GetReportMailingJobsResponse

Field Name Required Type Description Format

description

String

emailAttachmentFileFormat

EnumOptionData

emailMessage

String

emailRecipients

String

emailSubject

String

id

Long

int64

isActive

Boolean

name

String

nextRunDateTime

Date

date-time

numberOfRuns

Integer

int32

recurrence

String

runAsUserId

Long

int64

startDateTime

Date

date-time

stretchyReport

Object

stretchyReportParamMap

String

timeline

Object

.2.543. GetReportMailingJobsTemplate

GetReportMailingJobsTemplate

Field Name Required Type Description Format

emailAttachmentFileFormatOptions

List of Section .2.72

isActive

Boolean

stretchyReportParamDateOptions

List of Section .2.72

.2.544. GetReportsResponse

GetReportsResponse

Field Name Required Type Description Format

coreReport

Boolean

description

String

id

Long

int64

reportCategory

String

reportName

String

reportParameters

List of [object]

reportSql

String

reportSubType

String

reportType

String

useReport

Boolean

.2.545. GetReportsTemplateResponse

GetReportsTemplateResponse

Field Name Required Type Description Format

allowedParameters

List of [object]

allowedReportSubTypes

List of [string]

allowedReportTypes

List of [string]

.2.546. GetResourceTypeResourceIdNotesNoteIdResponse

GetResourceTypeResourceIdNotesNoteIdResponse

Field Name Required Type Description Format

clientId

Integer

int32

createdById

Integer

int32

createdByUsername

String

createdOn

Date

date-time

id

Integer

int32

note

String

noteType

GetNotesNoteType

updatedById

Integer

int32

updatedByUsername

String

updatedOn

Date

date-time

.2.547. GetResourceTypeResourceIdNotesResponse

GetResourceTypeResourceIdNotesResponse

Field Name Required Type Description Format

clientId

Integer

int32

createdById

Integer

int32

createdByUsername

String

createdOn

Date

date-time

id

Integer

int32

note

String

noteType

GetNotesNoteType

updatedById

Integer

int32

updatedByUsername

String

updatedOn

Date

date-time

.2.548. GetRolesResponse

GetRolesResponse

Field Name Required Type Description Format

description

String

id

Long

int64

name

String

.2.549. GetRolesRoleIdPermissionsResponse

GetRolesRoleIdPermissionsResponse

Field Name Required Type Description Format

description

String

id

Long

int64

name

String

permissionUsageData

List of Section .2.550

.2.550. GetRolesRoleIdPermissionsResponsePermissionData

Field Name Required Type Description Format

actionName

String

code

String

entityName

String

grouping

String

selected

Boolean

.2.551. GetRolesRoleIdResponse

GetRolesRoleIdResponse

Field Name Required Type Description Format

description

String

id

Long

int64

name

String

.2.552. GetRunReportColumnHeaders

Field Name Required Type Description Format

columnName

String

columnType

String

columnValues

String

isColumnNullable

Boolean

isColumnPrimaryKey

Boolean

.2.553. GetRunReportResponse

GetRunReportResponse

Field Name Required Type Description Format

columnHeaders

Set of Section .2.552

data

Set of Section .2.453

.2.554. GetSavingsAccountsAccountIdResponse

GetSavingsAccountsAccountIdResponse

Field Name Required Type Description Format

accountNo

String

clientId

Integer

int32

clientName

String

currency

GetSavingsCurrency

fieldOfficerId

Integer

int32

id

Integer

int32

interestCalculationDaysInYearType

GetSavingsInterestCalculationDaysInYearType

interestCalculationType

GetSavingsInterestCalculationType

interestCompoundingPeriodType

GetSavingsInterestCompoundingPeriodType

interestPostingPeriodType

GetSavingsInterestPostingPeriodType

nominalAnnualInterestRate

Double

double

savingsProductId

Integer

int32

savingsProductName

String

status

GetSavingsStatus

summary

GetSavingsAccountsSummary

timeline

GetSavingsTimeline

.2.555. GetSavingsAccountsResponse

GetSavingsAccountsResponse

Field Name Required Type Description Format

pageItems

Set of Section .2.572

totalFilteredRecords

Integer

int32

.2.556. GetSavingsAccountsSavingsAccountIdChargesResponse

GetSavingsAccountsSavingsAccountIdChargesResponse

Field Name Required Type Description Format

accountId

Integer

int32

amount

Float

float

amountOrPercentage

Float

float

amountOutstanding

Float

float

amountPaid

Float

float

amountPercentageAppliedTo

Double

double

amountWaived

Float

float

amountWrittenOff

Float

float

chargeCalculationType

GetChargesChargeCalculationType

chargeId

Integer

int32

chargeTimeType

GetChargesChargeTimeType

currency

GetChargesCurrencyResponse

id

Integer

int32

name

String

penalty

Boolean

percentage

Double

double

.2.557. GetSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdResponse

GetSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdResponse

Field Name Required Type Description Format

amount

Float

float

amountOrPercentage

Float

float

amountOutstanding

Float

float

amountPaid

Float

float

amountPercentageAppliedTo

Double

double

amountWaived

Float

float

amountWrittenOff

Float

float

chargeCalculationType

GetChargesChargeCalculationType

chargeId

Integer

int32

chargeTimeType

GetChargesChargeTimeType

currency

GetChargesCurrencyResponse

id

Integer

int32

name

String

penalty

Boolean

percentage

Double

double

.2.558. GetSavingsAccountsSavingsAccountIdChargesTemplateResponse

GetSavingsAccountsSavingsAccountIdChargesTemplateResponse

Field Name Required Type Description Format

amountPaid

Float

float

amountWaived

Float

float

amountWrittenOff

Float

float

chargeOptions

Set of Section .2.566

penalty

Boolean

.2.559. GetSavingsAccountsSummary

Field Name Required Type Description Format

accountBalance

Integer

int32

availableBalance

Integer

int32

currency

GetSavingsCurrency

.2.560. GetSavingsAccountsTemplateResponse

GetSavingsAccountsTemplateResponse

Field Name Required Type Description Format

clientId

Integer

int32

clientName

String

productOptions

Set of Section .2.573

.2.561. GetSavingsAssetLiabilityType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.562. GetSavingsChargeCalculationType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.563. GetSavingsChargePaymentMode

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.564. GetSavingsChargeTimeType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.565. GetSavingsChargesChargeTimeType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.566. GetSavingsChargesOptions

Field Name Required Type Description Format

active

Boolean

amount

Float

float

chargeCalculationType

GetChargesChargeCalculationType

chargeTimeType

GetSavingsChargesChargeTimeType

chargesAppliesTo

GetChargesAppliesTo

currency

GetChargesCurrencyResponse

id

Integer

int32

name

String

penalty

Boolean

.2.567. GetSavingsCurrency

Field Name Required Type Description Format

code

String

decimalPlaces

Integer

int32

displayLabel

String

displaySymbol

String

name

String

nameCode

String

.2.568. GetSavingsInterestCalculationDaysInYearType

Field Name Required Type Description Format

code

String

id

Integer

int32

value

String

.2.569. GetSavingsInterestCalculationType

Field Name Required Type Description Format

code

String

id

Integer

int32

value

String

.2.570. GetSavingsInterestCompoundingPeriodType

Field Name Required Type Description Format

code

String

id

Integer

int32

value

String

.2.571. GetSavingsInterestPostingPeriodType

Field Name Required Type Description Format

code

String

id

Integer

int32

value

String

.2.572. GetSavingsPageItems

Field Name Required Type Description Format

accountNo

String

clientId

Integer

int32

clientName

String

currency

GetSavingsCurrency

fieldOfficerId

Integer

int32

id

Integer

int32

interestCalculationDaysInYearType

GetSavingsInterestCalculationDaysInYearType

interestCalculationType

GetSavingsInterestCalculationType

interestCompoundingPeriodType

GetSavingsInterestCompoundingPeriodType

interestPostingPeriodType

GetSavingsInterestPostingPeriodType

nominalAnnualInterestRate

Double

double

savingsProductId

Integer

int32

savingsProductName

String

status

GetSavingsStatus

summary

GetSavingsSummary

timeline

GetSavingsTimeline

.2.573. GetSavingsProductOptions

Field Name Required Type Description Format

id

Integer

int32

name

String

.2.574. GetSavingsProductsAccountingMappingOptions

Field Name Required Type Description Format

assetAccountOptions

Set of Section .2.577

expenseAccountOptions

Set of Section .2.580

incomeAccountOptions

Set of Section .2.586

liabilityAccountOptions

Set of Section .2.595

.2.575. GetSavingsProductsAccountingMappings

Field Name Required Type Description Format

incomeFromFeeAccount

GetSavingsProductsIncomeFromFeeAccount

incomeFromPenaltyAccount

GetSavingsProductsIncomeFromPenaltyAccount

interestOnSavingsAccount

GetSavingsProductsInterestOnSavingsAccount

savingsControlAccount

GetSavingsProductsSavingsControlAccount

savingsReferenceAccount

GetSavingsProductsSavingsReferenceAccount

transfersInSuspenseAccount

GetSavingsProductsTransfersInSuspenseAccount

.2.576. GetSavingsProductsAccountingRule

Field Name Required Type Description Format

code

String

id

Integer

int32

value

String

.2.577. GetSavingsProductsAssetAccountOptions

Field Name Required Type Description Format

disabled

Boolean

glCode

Integer

int32

id

Integer

int32

manualEntriesAllowed

Boolean

name

String

tagId

Object

type

GetSavingsAssetLiabilityType

usage

GetSavingsProductsLiabilityUsage

.2.578. GetSavingsProductsChargeAppliesTo

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.579. GetSavingsProductsChargeOptions

Field Name Required Type Description Format

active

Boolean

amount

Long

int64

chargeAppliesTo

GetSavingsProductsChargeAppliesTo

chargeCalculationType

GetSavingsChargeCalculationType

chargePaymentMode

GetSavingsChargePaymentMode

chargeTimeType

GetSavingsChargeTimeType

currency

GetSavingsCurrency

id

Integer

int32

name

String

penalty

Boolean

.2.580. GetSavingsProductsExpenseAccountOptions

Field Name Required Type Description Format

disabled

Boolean

glCode

Integer

int32

id

Integer

int32

manualEntriesAllowed

Boolean

name

String

tagId

Object

type

GetSavingsProductsExpenseType

usage

GetSavingsProductsLiabilityUsage

.2.581. GetSavingsProductsExpenseType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.582. GetSavingsProductsFeeToIncomeAccountMappings

Field Name Required Type Description Format

charge

GetSavingsProductsFeeToIncomeAccountMappingsCharge

incomeAccount

GetSavingsProductsFeeToIncomeAccountMappingsIncomeAccount

.2.583. GetSavingsProductsFeeToIncomeAccountMappingsCharge

Field Name Required Type Description Format

active

Boolean

id

Integer

int32

name

String

penalty

Boolean

.2.584. GetSavingsProductsFeeToIncomeAccountMappingsIncomeAccount

Field Name Required Type Description Format

glCode

Integer

int32

id

Integer

int32

name

String

.2.585. GetSavingsProductsFundSourceAccount

Field Name Required Type Description Format

glCode

Integer

int32

id

Integer

int32

name

String

.2.586. GetSavingsProductsIncomeAccountOptions

Field Name Required Type Description Format

disabled

Boolean

glCode

Integer

int32

id

Integer

int32

manualEntriesAllowed

Boolean

name

String

tagId

Object

type

GetSavingsProductsIncomeType

usage

GetSavingsProductsLiabilityUsage

.2.587. GetSavingsProductsIncomeFromFeeAccount

Field Name Required Type Description Format

glCode

Integer

int32

id

Integer

int32

name

String

.2.588. GetSavingsProductsIncomeFromPenaltyAccount

Field Name Required Type Description Format

glCode

Integer

int32

id

Integer

int32

name

String

.2.589. GetSavingsProductsIncomeType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.590. GetSavingsProductsInterestCalculationDaysInYearType

Field Name Required Type Description Format

code

String

id

Integer

int32

value

String

.2.591. GetSavingsProductsInterestCalculationType

Field Name Required Type Description Format

code

String

id

Integer

int32

value

String

.2.592. GetSavingsProductsInterestCompoundingPeriodType

Field Name Required Type Description Format

code

String

id

Integer

int32

value

String

.2.593. GetSavingsProductsInterestOnSavingsAccount

Field Name Required Type Description Format

glCode

Integer

int32

id

Integer

int32

name

String

.2.594. GetSavingsProductsInterestPostingPeriodType

Field Name Required Type Description Format

code

String

id

Integer

int32

value

String

.2.595. GetSavingsProductsLiabilityAccountOptions

Field Name Required Type Description Format

disabled

Boolean

glCode

Integer

int32

id

Integer

int32

manualEntriesAllowed

Boolean

name

String

nameDecorated

String

tagId

GetSavingsProductsLiabilityTagId

type

GetSavingsProductsLiabilityType

usage

GetSavingsProductsLiabilityUsage

.2.596. GetSavingsProductsLiabilityTagId

Field Name Required Type Description Format

id

Integer

int32

.2.597. GetSavingsProductsLiabilityType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.598. GetSavingsProductsLiabilityUsage

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.599. GetSavingsProductsLockinPeriodFrequencyTypeOptions

Field Name Required Type Description Format

code

String

id

Integer

int32

value

String

.2.600. GetSavingsProductsPaymentChannelToFundSourceMappings

Field Name Required Type Description Format

fundSourceAccount

GetSavingsProductsFundSourceAccount

paymentType

GetSavingsProductsPaymentType

.2.601. GetSavingsProductsPaymentType

Field Name Required Type Description Format

id

Integer

int32

name

String

.2.602. GetSavingsProductsPaymentTypeOptions

Field Name Required Type Description Format

description

String

id

Integer

int32

isCashPayment

Boolean

name

String

position

Integer

int32

.2.603. GetSavingsProductsPenaltyToIncomeAccountMappings

Field Name Required Type Description Format

charge

GetSavingsProductsPenaltyToIncomeAccountMappingsCharge

incomeAccount

GetSavingsProductsIncomeFromPenaltyAccount

.2.604. GetSavingsProductsPenaltyToIncomeAccountMappingsCharge

Field Name Required Type Description Format

active

Boolean

id

Integer

int32

name

String

penalty

Boolean

.2.605. GetSavingsProductsProductIdResponse

GetSavingsProductsProductIdResponse

Field Name Required Type Description Format

accountingMappings

GetSavingsProductsAccountingMappings

accountingRule

GetSavingsProductsAccountingRule

charges

List of [integer]

int32

currency

GetSavingsCurrency

description

String

feeToIncomeAccountMappings

Set of Section .2.582

id

Integer

int32

interestCalculationDaysInYearType

GetSavingsProductsInterestCalculationDaysInYearType

interestCalculationType

GetSavingsProductsInterestCalculationType

interestCompoundingPeriodType

GetSavingsProductsInterestCompoundingPeriodType

interestPostingPeriodType

GetSavingsProductsInterestPostingPeriodType

name

String

nominalAnnualInterestRate

BigDecimal

paymentChannelToFundSourceMappings

Set of Section .2.600

penaltyToIncomeAccountMappings

Set of Section .2.603

shortName

String

withdrawalFeeForTransfers

Boolean

.2.606. GetSavingsProductsResponse

GetSavingsProductsResponse

Field Name Required Type Description Format

accountingRule

GetSavingsProductsAccountingRule

currency

GetSavingsCurrency

description

String

id

Integer

int32

interestCalculationDaysInYearType

GetSavingsProductsInterestCalculationDaysInYearType

interestCalculationType

GetSavingsProductsInterestCalculationType

interestCompoundingPeriodType

GetSavingsProductsInterestCompoundingPeriodType

interestPostingPeriodType

GetSavingsProductsInterestPostingPeriodType

name

String

nominalAnnualInterestRate

BigDecimal

shortName

String

withdrawalFeeForTransfers

Boolean

.2.607. GetSavingsProductsSavingsControlAccount

Field Name Required Type Description Format

glCode

Integer

int32

id

Integer

int32

name

String

.2.608. GetSavingsProductsSavingsReferenceAccount

Field Name Required Type Description Format

glCode

Integer

int32

id

Integer

int32

name

String

.2.609. GetSavingsProductsTemplateAccountingRule

Field Name Required Type Description Format

code

String

id

Integer

int32

value

String

.2.610. GetSavingsProductsTemplateResponse

GetSavingsProductsTemplateResponse

Field Name Required Type Description Format

accountMapping

GetSavingsCurrency

accountingMappingOptions

GetSavingsProductsAccountingMappingOptions

accountingRule

GetSavingsProductsTemplateAccountingRule

accountingRuleOptions

Set of Section .2.609

chargeOptions

Set of Section .2.579

currency

GetSavingsCurrency

currencyOptions

Set of Section .2.567

interestCalculationDaysInYearType

GetSavingsProductsInterestCalculationDaysInYearType

interestCalculationDaysInYearTypeOptions

Set of Section .2.590

interestCalculationType

GetSavingsProductsInterestCalculationType

interestCalculationTypeOptions

Set of Section .2.591

interestCompoundingPeriodType

GetSavingsProductsInterestCompoundingPeriodType

interestCompoundingPeriodTypeOptions

Set of Section .2.592

interestPostingPeriodType

GetSavingsProductsInterestPostingPeriodType

interestPostingPeriodTypeOptions

Set of Section .2.594

lockinPeriodFrequencyTypeOptions

Set of Section .2.599

paymentTypeOptions

Set of Section .2.602

withdrawalFeeTypeOptions

Set of Section .2.612

.2.611. GetSavingsProductsTransfersInSuspenseAccount

Field Name Required Type Description Format

glCode

Integer

int32

id

Integer

int32

name

String

.2.612. GetSavingsProductsWithdrawalFeeTypeOptions

Field Name Required Type Description Format

code

String

id

Integer

int32

value

String

.2.613. GetSavingsStatus

Field Name Required Type Description Format

active

Boolean

approved

Boolean

closed

Boolean

code

String

id

Integer

int32

rejected

Boolean

submittedAndPendingApproval

Boolean

value

String

withdrawnByApplicant

Boolean

.2.614. GetSavingsSummary

Field Name Required Type Description Format

accountBalance

Integer

int32

currency

GetSavingsCurrency

.2.615. GetSavingsTimeline

Field Name Required Type Description Format

activatedOnDate

date

date

approvedByFirstname

String

approvedByLastname

String

approvedByUsername

String

approvedOnDate

date

date

submittedByFirstname

String

submittedByLastname

String

submittedByUsername

String

submittedOnDate

date

date

.2.616. GetSchedulerResponse

GetSchedulerResponse

Field Name Required Type Description Format

active

Boolean

.2.617. GetSearchResponse

GetSearchResponse

Field Name Required Type Description Format

entityAccountNo

Long

int64

entityExternalId

String

entityId

Long

int64

entityName

String

entityStatus

EnumOptionData

entityType

String

parentId

Long

int64

parentName

String

.2.618. GetSelfBeneficiariesAccountOptions

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.619. GetSelfBeneficiariesTPTResponse

GetSelfBeneficiariesTPTResponse

Field Name Required Type Description Format

accountNumber

Long

int64

accountType

GetSelfBeneficiariesAccountOptions

clientName

String

id

Integer

int32

name

String

officeName

String

transferLimit

Integer

int32

.2.620. GetSelfBeneficiariesTPTTemplateResponse

GetSelfBeneficiariesTPTTemplateResponse

Field Name Required Type Description Format

accountTypeOptions

Set of Section .2.618

.2.621. GetSelfClientsChargeCalculationType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.622. GetSelfClientsChargeTimeType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.623. GetSelfClientsChargesPageItems

Field Name Required Type Description Format

amount

Float

float

amountOutstanding

Float

float

amountPaid

Float

float

amountWaived

Float

float

amountWrittenOff

Float

float

chargeCalculationType

GetSelfClientsChargeCalculationType

chargeId

Integer

int32

chargeTimeType

GetSelfClientsChargeTimeType

clientId

Integer

int32

currency

GetSelfClientsSavingsAccountsCurrency

dueDate

date

date

id

Integer

int32

isActive

Boolean

isPaid

Boolean

isWaived

Boolean

name

String

penalty

Boolean

.2.624. GetSelfClientsClientIdAccountsResponse

GetSelfClientsClientIdAccountsResponse

Field Name Required Type Description Format

loanAccounts

Set of Section .2.632

savingsAccounts

Set of Section .2.637

.2.625. GetSelfClientsClientIdChargesChargeIdResponse

GetSelfClientsClientIdChargesChargeIdResponse

Field Name Required Type Description Format

amount

Float

float

amountOutstanding

Float

float

amountPaid

Float

float

amountWaived

Float

float

amountWrittenOff

Float

float

chargeCalculationType

GetSelfClientsChargeCalculationType

chargeId

Integer

int32

chargeTimeType

GetSelfClientsChargeTimeType

clientId

Integer

int32

currency

GetSelfClientsSavingsAccountsCurrency

dueDate

date

date

id

Integer

int32

isActive

Boolean

isPaid

Boolean

isWaived

Boolean

name

String

penalty

Boolean

.2.626. GetSelfClientsClientIdChargesResponse

GetSelfClientsClientIdChargesResponse

Field Name Required Type Description Format

pageItems

Set of Section .2.623

totalFilteredRecords

Integer

int32

.2.627. GetSelfClientsClientIdResponse

GetSelfClientsClientIdResponse

Field Name Required Type Description Format

accountNo

Long

int64

activationDate

date

date

active

Boolean

displayName

String

firstname

String

groups

List of [string]

id

Integer

int32

lastname

String

officeId

Integer

int32

officeName

String

savingsProductId

Integer

int32

savingsProductName

String

status

GetSelfClientsStatus

timeline

GetSelfClientsTimeline

.2.628. GetSelfClientsClientIdTransactionsPageItems

Field Name Required Type Description Format

amount

Double

double

currency

GetSelfClientsSavingsAccountsCurrency

date

date

date

id

Integer

int32

officeId

Integer

int32

officeName

String

reversed

Boolean

submittedOnDate

date

date

type

GetSelfClientsClientIdTransactionsType

.2.629. GetSelfClientsClientIdTransactionsResponse

GetSelfClientsClientIdTransactionsResponse

Field Name Required Type Description Format

pageItems

Set of Section .2.628

totalFilteredRecords

Integer

int32

.2.630. GetSelfClientsClientIdTransactionsTransactionIdResponse

GetSelfClientsClientIdTransactionsTransactionIdResponse

Field Name Required Type Description Format

amount

Float

float

currency

GetSelfClientsSavingsAccountsCurrency

date

date

date

id

Integer

int32

officeId

Integer

int32

officeName

String

reversed

Boolean

submittedOnDate

date

date

type

GetSelfClientsClientIdTransactionsType

.2.631. GetSelfClientsClientIdTransactionsType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.632. GetSelfClientsLoanAccounts

Field Name Required Type Description Format

accountNo

Long

int64

externalId

Integer

int32

id

Integer

int32

loanCycle

Integer

int32

loanType

GetSelfClientsLoanAccountsType

productId

Integer

int32

productName

String

status

GetSelfClientsLoanAccountsStatus

.2.633. GetSelfClientsLoanAccountsStatus

Field Name Required Type Description Format

active

Boolean

closed

Boolean

closedObligationsMet

Boolean

closedRescheduled

Boolean

closedWrittenOff

Boolean

code

String

description

String

id

Integer

int32

overpaid

Boolean

pendingApproval

Boolean

waitingForDisbursal

Boolean

.2.634. GetSelfClientsLoanAccountsType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.635. GetSelfClientsPageItems

Field Name Required Type Description Format

accountNo

Long

int64

activationDate

date

date

active

Boolean

displayName

String

fullname

String

id

Integer

int32

officeId

Integer

int32

officeName

String

status

GetSelfClientsStatus

.2.636. GetSelfClientsResponse

GetSelfClientsResponse

Field Name Required Type Description Format

pageItems

Set of Section .2.635

totalFilteredRecords

Integer

int32

.2.637. GetSelfClientsSavingsAccounts

Field Name Required Type Description Format

accountNo

Long

int64

currency

GetSelfClientsSavingsAccountsCurrency

id

Integer

int32

productId

Integer

int32

productName

String

status

GetSelfClientsSavingsAccountsStatus

.2.638. GetSelfClientsSavingsAccountsCurrency

Field Name Required Type Description Format

code

String

decimalPlaces

Integer

int32

displayLabel

String

displaySymbol

String

name

String

nameCode

String

.2.639. GetSelfClientsSavingsAccountsStatus

Field Name Required Type Description Format

active

Boolean

approved

Boolean

closed

Boolean

code

String

description

String

id

Integer

int32

rejected

Boolean

submittedAndPendingApproval

Boolean

withdrawnByApplicant

Boolean

.2.640. GetSelfClientsStatus

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.641. GetSelfClientsTimeline

Field Name Required Type Description Format

activatedByFirstname

String

activatedByLastname

String

activatedByUsername

String

activatedOnDate

date

date

submittedByFirstname

String

submittedByLastname

String

submittedByUsername

String

submittedOnDate

date

date

.2.642. GetSelfLoansChargeCalculationType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.643. GetSelfLoansChargeTimeType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.644. GetSelfLoansLoanIdChargesResponse

GetSelfLoansLoanIdChargesResponse

Field Name Required Type Description Format

amount

Float

float

amountOrPercentage

Float

float

amountOutstanding

Float

float

amountPaid

Float

float

amountPercentageAppliedTo

Double

double

amountWaived

Float

float

amountWrittenOff

Float

float

chargeCalculationType

GetSelfLoansChargeCalculationType

chargeId

Integer

int32

chargeTimeType

GetSelfLoansChargeTimeType

currency

GetLoanCurrency

id

Integer

int32

name

String

penalty

Boolean

percentage

Double

double

.2.645. GetSelfLoansLoanIdResponse

GetSelfLoansLoanIdResponse

Field Name Required Type Description Format

accountNo

Long

int64

amortizationType

GetLoansLoanIdAmortizationType

annualInterestRate

Integer

int32

clientId

Integer

int32

clientName

String

clientOfficeId

Integer

int32

currency

GetLoansLoanIdCurrency

id

Long

int64

interestCalculationPeriodType

GetLoansLoanIdInterestCalculationPeriodType

interestRateFrequencyType

GetLoansLoanIdInterestRateFrequencyType

interestRatePerPeriod

Integer

int32

interestType

GetLoansLoanIdInterestType

loanOfficerId

Integer

int32

loanOfficerName

String

loanProductDescription

String

loanProductId

Integer

int32

loanProductName

String

loanPurposeId

Integer

int32

loanPurposeName

String

loanType

GetLoansLoanIdLoanType

numberOfRepayments

Integer

int32

principal

Long

int64

repaymentEvery

Integer

int32

repaymentFrequencyType

GetLoansLoanIdRepaymentFrequencyType

status

GetLoansLoanIdStatus

summary

GetLoansLoanIdSummary

termFrequency

Integer

int32

termPeriodFrequencyType

GetLoansLoanIdTermPeriodFrequencyType

timeline

GetLoansLoanIdTimeline

transactionProcessingStrategyId

Integer

int32

.2.646. GetSelfLoansLoanIdTransactionsTransactionIdResponse

GetSelfLoansLoanIdTransactionsTransactionIdResponse

Field Name Required Type Description Format

amount

Float

float

currency

GetLoanCurrency

date

date

date

id

Integer

int32

interestPortion

Float

float

manuallyReversed

Boolean

type

GetSelfLoansLoanIdTransactionsType

.2.647. GetSelfLoansLoanIdTransactionsType

Field Name Required Type Description Format

code

String

contra

Boolean

description

String

disbursement

Boolean

id

Integer

int32

recoveryRepayment

Boolean

repayment

Boolean

repaymentAtDisbursement

Boolean

waiveCharges

Boolean

waiveInterest

Boolean

writeOff

Boolean

.2.648. GetSelfLoansProductOptions

Field Name Required Type Description Format

id

Integer

int32

name

String

.2.649. GetSelfLoansTemplateResponse

GetSelfLoansTemplateResponse

Field Name Required Type Description Format

clientId

Integer

int32

clientName

String

clientOfficeId

Integer

int32

productOptions

Set of Section .2.648

timeline

GetSelfLoansTimeline

.2.650. GetSelfLoansTimeline

Field Name Required Type Description Format

expectedDisbursementDate

date

date

.2.651. GetSelfSavingsAccountsAccountIdChargesResponse

GetSelfSavingsAccountsAccountIdChargesResponse

Field Name Required Type Description Format

accountId

Integer

int32

amount

Integer

int32

amountOrPercentage

Integer

int32

amountOutstanding

Integer

int32

amountPaid

Integer

int32

amountPercentageAppliedTo

Double

double

amountWaived

Integer

int32

amountWrittenOff

Integer

int32

chargeCalculationType

GetSelfSavingsChargeCalculationType

chargeId

Integer

int32

chargeTimeType

GetSelfSavingsChargeTimeType

currency

GetSelfSavingsCurrency

id

Integer

int32

name

String

penalty

Boolean

percentage

Double

double

.2.652. GetSelfSavingsAccountsAccountIdChargesSavingsAccountChargeIdResponse

GetSelfSavingsAccountsAccountIdChargesSavingsAccountChargeIdResponse

Field Name Required Type Description Format

amount

Integer

int32

amountOrPercentage

Integer

int32

amountOutstanding

Integer

int32

amountPaid

Integer

int32

amountPercentageAppliedTo

Double

double

amountWaived

Integer

int32

amountWrittenOff

Integer

int32

chargeCalculationType

GetSelfSavingsChargeCalculationType

chargeId

Integer

int32

chargeTimeType

GetSelfSavingsChargeTimeType

currency

GetSelfSavingsCurrency

id

Integer

int32

name

String

penalty

Boolean

percentage

Double

double

.2.653. GetSelfSavingsAccountsAccountIdTransactionsTransactionIdResponse

GetSelfSavingsAccountsAccountIdTransactionsTransactionIdResponse

Field Name Required Type Description Format

accountId

Integer

int32

accountNo

Long

int64

amount

Integer

int32

currency

GetSelfSavingsTransactionCurrency

date

date

date

id

Integer

int32

paymentDetailData

GetSelfSavingsPaymentDetailData

reversed

Boolean

runningBalance

Integer

int32

transactionType

GetSelfSavingsTransactionType

.2.654. GetSelfSavingsAccountsResponse

GetSelfSavingsAccountsResponse

Field Name Required Type Description Format

accountNo

Long

int64

clientId

Integer

int32

clientName

String

currency

GetSelfSavingsCurrency

fieldOfficerId

Integer

int32

id

Integer

int32

interestCalculationDaysInYearType

GetSelfSavingsInterestCalculationDaysInYearType

interestCalculationType

GetSelfSavingsInterestCalculationType

interestCompoundingPeriodType

GetSelfSavingsInterestCompoundingPeriodType

interestPostingPeriodType

GetSelfSavingsInterestPostingPeriodType

nominalAnnualInterestRate

Double

double

savingsProductId

Integer

int32

savingsProductName

String

status

GetSelfSavingsStatus

summary

GetSelfSavingsSummary

timeline

GetSelfSavingsTimeline

.2.655. GetSelfSavingsChargeCalculationType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.656. GetSelfSavingsChargeTimeType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.657. GetSelfSavingsCurrency

Field Name Required Type Description Format

code

String

decimalPlaces

Integer

int32

displayLabel

String

displaySymbol

String

name

String

nameCode

String

.2.658. GetSelfSavingsInterestCalculationDaysInYearType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.659. GetSelfSavingsInterestCalculationType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.660. GetSelfSavingsInterestCompoundingPeriodType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.661. GetSelfSavingsInterestPostingPeriodType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.662. GetSelfSavingsPaymentDetailData

Field Name Required Type Description Format

accountNumber

Integer

int32

bankNumber

Integer

int32

checkNumber

Integer

int32

id

Integer

int32

paymentType

GetSelfSavingsPaymentType

receiptNumber

Integer

int32

routingCode

Integer

int32

.2.663. GetSelfSavingsPaymentType

Field Name Required Type Description Format

id

Integer

int32

name

String

.2.664. GetSelfSavingsStatus

Field Name Required Type Description Format

active

Boolean

approved

Boolean

closed

Boolean

code

String

description

String

id

Integer

int32

rejected

Boolean

submittedAndPendingApproval

Boolean

withdrawnByApplicant

Boolean

.2.665. GetSelfSavingsSummary

Field Name Required Type Description Format

accountBalance

Integer

int32

currency

GetSelfSavingsCurrency

.2.666. GetSelfSavingsTimeline

Field Name Required Type Description Format

submittedOnDate

date

date

.2.667. GetSelfSavingsTransactionCurrency

Field Name Required Type Description Format

code

String

decimalPlaces

Integer

int32

displayLabel

String

displaySymbol

String

inMultiplesOf

Integer

int32

name

String

nameCode

String

.2.668. GetSelfSavingsTransactionType

Field Name Required Type Description Format

code

String

deposit

Boolean

description

String

feeDeduction

Boolean

id

Integer

int32

interestPosting

Boolean

withdrawal

Boolean

.2.669. GetSelfUserDetailsOrganisationalRole

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.670. GetSelfUserDetailsResponse

GetSelfUserDetailsResponse

Field Name Required Type Description Format

authenticated

Boolean

base64EncodedAuthenticationKey

String

clients

List of [integer]

int32

isSelfServiceUser

Boolean

officeId

Integer

int32

officeName

String

organisationalRole

GetSelfUserDetailsOrganisationalRole

permissions

List of [string]

roles

Set of Section .2.671

staffDisplayName

String

staffId

Integer

int32

userId

Integer

int32

username

String

.2.671. GetSelfUserDetailsRoles

Field Name Required Type Description Format

description

String

id

Integer

int32

name

String

.2.672. GetShareAccountsChargeAppliesTo

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.673. GetShareAccountsChargeCalculationType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.674. GetShareAccountsChargeOptions

Field Name Required Type Description Format

active

Boolean

amount

Integer

int32

calculationType

GetShareAccountsChargeCalculationType

chargeAppliesTo

GetShareAccountsChargeAppliesTo

chargeTimeType

GetShareAccountsChargeTimeType

currency

GetShareAccountsCurrency

id

Integer

int32

name

String

paymentMode

GetShareAccountsChargePaymentMode

penalty

Boolean

.2.675. GetShareAccountsChargePaymentMode

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.676. GetShareAccountsChargeTimeType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.677. GetShareAccountsClientIdProductIdAccountingRule

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.678. GetShareAccountsClientIdProductIdLockPeriodTypeEnum

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.679. GetShareAccountsClientIdProductIdMinimumActivePeriodForDividendsTypeEnum

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.680. GetShareAccountsClientIdProductIdResponse

GetShareAccountsClientIdProductIdResponse

Field Name Required Type Description Format

chargeOptions

Set of Section .2.179

productOptions

Set of Section .2.182

.2.681. GetShareAccountsCurrency

Field Name Required Type Description Format

code

String

decimalPlaces

Integer

int32

displayLabel

String

displaySymbol

String

name

String

nameCode

String

.2.682. GetShareAccountsIncomeFromFeeAccountId

Field Name Required Type Description Format

glCode

Integer

int32

id

Integer

int32

name

String

.2.683. GetShareAccountsShareEquityId

Field Name Required Type Description Format

glCode

Integer

int32

id

Integer

int32

name

String

.2.684. GetShareAccountsShareReferenceId

Field Name Required Type Description Format

glCode

Integer

int32

id

Integer

int32

name

String

.2.685. GetShareAccountsShareSuspenseId

Field Name Required Type Description Format

glCode

Integer

int32

id

Integer

int32

name

String

.2.686. GetShareEquityId

Field Name Required Type Description Format

glCode

String

id

Integer

int32

name

String

.2.687. GetShareReferenceId

Field Name Required Type Description Format

glCode

String

id

Integer

int32

name

String

.2.688. GetShareSuspenseId

Field Name Required Type Description Format

glCode

String

id

Integer

int32

name

String

.2.689. GetStandingInstructionHistoryFromAccount

Field Name Required Type Description Format

accountNo

Long

int64

id

Long

int64

productId

Long

int64

productName

String

.2.690. GetStandingInstructionHistoryPageItemsFromClient

Field Name Required Type Description Format

displayName

String

id

Long

int64

officeId

Long

int64

officeName

String

.2.691. GetStandingInstructionHistoryPageItemsResponse

Field Name Required Type Description Format

amount

Float

float

errorLog

String

executionTime

date

date

fromAccount

GetStandingInstructionHistoryFromAccount

fromAccountType

GetFromAccountTypeStandingInstructionSwagger

fromClient

GetStandingInstructionHistoryPageItemsFromClient

fromOffice

GetFromOfficeStandingInstructionSwagger

name

String

standingInstructionId

Long

int64

status

String

toAccount

GetStandingInstructionHistoryToAccount

toAccountType

GetToAccountTypeStandingInstructionSwagger

toClient

GetStandingInstructionHistoryToClient

toOffice

GetToOfficeStandingInstructionSwagger

.2.692. GetStandingInstructionHistoryToAccount

Field Name Required Type Description Format

accountNo

Long

int64

id

Long

int64

productId

Long

int64

productName

String

.2.693. GetStandingInstructionHistoryToClient

Field Name Required Type Description Format

displayName

String

id

Long

int64

officeId

Long

int64

officeName

String

.2.694. GetStandingInstructionRunHistoryResponse

GetStandingInstructionRunHistoryResponse

Field Name Required Type Description Format

pageItems

Set of Section .2.691

totalFilteredRecords

Integer

int32

.2.695. GetStandingInstructionsResponse

GetStandingInstructionsResponse

Field Name Required Type Description Format

pageItems

Set of Section .2.448

totalFilteredRecords

Integer

int32

.2.696. GetStandingInstructionsStandingInstructionIdResponse

GetStandingInstructionsStandingInstructionIdResponse

Field Name Required Type Description Format

accountDetailId

Long

int64

amount

Float

float

fromAccount

GetFromAccountStandingInstructionSwagger

fromAccountType

GetFromAccountTypeStandingInstructionSwagger

fromClient

GetFromClientStandingInstructionSwagger

fromOffice

GetFromOfficeStandingInstructionSwagger

id

Long

int64

instructionType

GetInstructionTypeStandingInstructionSwagger

name

String

priority

GetPriorityStandingInstructionSwagger

recurrenceFrequency

GetRecurrenceFrequencyStandingInstructionSwagger

recurrenceInterval

Integer

int32

recurrenceOnMonthDay

date

date

recurrenceType

GetRecurrenceTypeStandingInstructionSwagger

status

GetStatusStandingInstructionSwagger

toAccount

GetToAccountStandingInstructionSwagger

toAccountType

GetToAccountTypeStandingInstructionSwagger

toClient

GetToClientStandingInstructionSwagger

toOffice

GetToOfficeStandingInstructionSwagger

transferType

GetTransferTypeStandingInstructionSwagger

validFrom

date

date

.2.697. GetStandingInstructionsTemplateResponse

GetStandingInstructionsTemplateResponse

Field Name Required Type Description Format

fromAccountType

GetFromAccountTypeResponseStandingInstructionSwagger

fromAccountTypeOptions

Set of Section .2.288

fromClientOptions

Set of Section .2.291

fromOffice

GetFromOfficeResponseStandingInstructionSwagger

fromOfficeOptions

Set of Section .2.293

instructionTypeOptions

Set of Section .2.329

priorityOptions

Set of Section .2.457

recurrenceFrequencyOptions

Set of Section .2.478

recurrenceTypeOptions

Set of Section .2.480

statusOptions

Set of Section .2.698

toAccountTypeOptions

Set of Section .2.719

toOfficeOptions

Set of Section .2.722

transferTypeOptions

Set of Section .2.724

.2.698. GetStatusOptionsResponseStandingInstructionSwagger

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.699. GetStatusStandingInstructionSwagger

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.700. GetSurveyResponse

GetSurveyResponse

Field Name Required Type Description Format

datatableData

GetSurveyResponseDatatableData

enabled

Boolean

.2.701. GetSurveyResponseDatatableData

Field Name Required Type Description Format

applicationTableName

String

columnHeaderData

List of Section .2.1164

registeredTableName

String

.2.702. GetTaxesComponentsCreditAccount

Field Name Required Type Description Format

glCode

String

id

Integer

int32

name

String

.2.703. GetTaxesComponentsCreditAccountType

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.704. GetTaxesComponentsResponse

GetTaxesComponentsResponse

Field Name Required Type Description Format

creditAccount

GetTaxesComponentsCreditAccount

creditAccountType

GetTaxesComponentsCreditAccountType

id

Integer

int32

name

String

percentage

Float

float

startDate

date

date

taxComponentsHistories

Set of [object]

.2.705. GetTaxesGroupResponse

GetTaxesGroupResponse

Field Name Required Type Description Format

id

Integer

int32

name

String

taxAssociations

Set of Section .2.706

.2.706. GetTaxesGroupTaxAssociations

Field Name Required Type Description Format

id

Integer

int32

startDate

date

date

taxComponent

GetTaxesGroupTaxComponent

.2.707. GetTaxesGroupTaxComponent

Field Name Required Type Description Format

id

Integer

int32

name

String

.2.708. GetTellersResponse

GetTellersResponse

Field Name Required Type Description Format

creditAccountId

Long

int64

debitAccountId

Long

int64

id

Long

int64

name

String

officeId

Long

int64

officeName

String

startDate

date

date

status

String

Enum: INVALID, PENDING, ACTIVE, INACTIVE, CLOSED,

.2.709. GetTellersTellerIdCashiersCashierIdResponse

GetTellersTellerIdCashiersCashierIdResponse

Field Name Required Type Description Format

description

String

endDate

date

date

endTime

String

id

Long

int64

isFullDay

Boolean

staffId

Long

int64

staffName

String

startDate

date

date

startTime

String

tellerId

Long

int64

tellerName

String

.2.710. GetTellersTellerIdCashiersCashiersIdSummaryAndTransactionsResponse

GetTellersTellerIdCashiersCashiersIdSummaryAndTransactionsResponse

Field Name Required Type Description Format

cashierId

Long

int64

cashierName

String

cashierTransactions

PageCashierTransactionData

netCash

BigDecimal

officeName

String

sumCashAllocation

BigDecimal

sumCashSettlement

BigDecimal

sumInwardCash

BigDecimal

sumOutwardCash

BigDecimal

tellerId

Long

int64

tellerName

String

.2.711. GetTellersTellerIdCashiersCashiersIdTransactionsResponse

GetTellersTellerIdCashiersCashiersIdTransactionsResponse

Field Name Required Type Description Format

cashierId

Long

int64

cashierName

String

createdDate

Date

date-time

entityId

Long

int64

entityType

String

id

Long

int64

officeId

Long

int64

officeName

String

tellerId

Long

int64

txnAmount

BigDecimal

txnDate

Date

date-time

txnNote

String

txnType

CashierTxnType

.2.712. GetTellersTellerIdCashiersCashiersIdTransactionsTemplateResponse

GetTellersTellerIdCashiersCashiersIdTransactionsTemplateResponse

Field Name Required Type Description Format

cashierData

CashierData

cashierId

Long

int64

cashierName

String

currencyOptions

List of Section .2.25

endDate

date

date

officeName

String

startDate

date

date

tellerId

Long

int64

tellerName

String

.2.713. GetTellersTellerIdCashiersResponse

GetTellersTellerIdCashiersResponse

Field Name Required Type Description Format

cashiers

List of Section .2.9

officeId

Long

int64

officeName

String

tellerId

Long

int64

tellerName

String

.2.714. GetTellersTellerIdCashiersTemplateResponse

GetTellersTellerIdCashiersTemplateResponse

Field Name Required Type Description Format

officeId

Long

int64

officeName

String

staffOptions

List of Section .2.1177

tellerId

Long

int64

tellerName

String

.2.715. GetTemplatesResponse

GetTemplatesResponse

Field Name Required Type Description Format

entity

Long

int64

id

Long

int64

mappers

List of Section .2.1185

name

String

text

String

type

Long

int64

.2.716. GetTemplatesTemplateIdResponse

GetTemplatesTemplateIdResponse

Field Name Required Type Description Format

entity

Long

int64

id

Long

int64

mappers

List of Section .2.1185

name

String

text

String

type

Long

int64

.2.717. GetTemplatesTemplateResponse

GetTemplatesTemplateResponse

Field Name Required Type Description Format

entity

Long

int64

id

Long

int64

mappers

List of Section .2.1185

name

String

text

String

type

Long

int64

.2.718. GetToAccountStandingInstructionSwagger

Field Name Required Type Description Format

accountNo

Long

int64

id

Long

int64

productId

Long

int64

productName

String

.2.719. GetToAccountTypeOptionsResponseStandingInstructionSwagger

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.720. GetToAccountTypeStandingInstructionSwagger

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.721. GetToClientStandingInstructionSwagger

Field Name Required Type Description Format

displayName

String

id

Long

int64

officeId

Long

int64

officeName

String

.2.722. GetToOfficeOptionsResponseStandingInstructionSwagger

Field Name Required Type Description Format

id

Integer

int32

name

String

nameDecorated

String

.2.723. GetToOfficeStandingInstructionSwagger

Field Name Required Type Description Format

id

Long

int64

name

String

.2.724. GetTransferTypeOptionsResponseStandingInstructionSwagger

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.725. GetTransferTypeStandingInstructionSwagger

Field Name Required Type Description Format

code

String

description

String

id

Integer

int32

.2.726. GetUserDetailsResponse

GetUserDetailsResponse

Field Name Required Type Description Format

accessToken

String

authenticated

Boolean

officeId

Long

int64

officeName

String

organisationalRole

EnumOptionData

permissions

List of [string]

roles

List of Section .2.1168

staffDisplayName

String

staffId

Long

int64

userId

Long

int64

username

String

.2.727. GetUsersResponse

GetUsersResponse

Field Name Required Type Description Format

email

String

firstname

String

id

Long

int64

lastname

String

officeId

Long

int64

officeName

String

passwordNeverExpires

Boolean

selectedRoles

List of Section .2.1168

staff

StaffData

username

String

.2.728. GetUsersTemplateResponse

GetUsersTemplateResponse

Field Name Required Type Description Format

allowedOffices

List of Section .2.776

availableRoles

List of Section .2.1168

selfServiceRoles

List of Section .2.1168

.2.729. GetUsersUserIdResponse

GetUsersUserIdResponse

Field Name Required Type Description Format

availableRoles

List of Section .2.1168

email

String

firstname

String

id

Long

int64

lastname

String

officeId

Long

int64

officeName

String

passwordNeverExpires

Boolean

selectedRoles

List of Section .2.1168

staff

StaffData

username

String

.2.730. GetWorkingDaysResponse

GetWorkingDaysResponse

Field Name Required Type Description Format

extendTermForDailyRepayments

Boolean

id

Long

int64

recurrence

String

repaymentRescheduleType

EnumOptionData

.2.731. GetWorkingDaysTemplateResponse

GetWorkingDaysTemplateResponse

Field Name Required Type Description Format

repaymentRescheduleOptions

List of Section .2.72

.2.732. GlobalConfigurationPropertyData

Field Name Required Type Description Format

dateValue

Date

date-time

description

String

enabled

Boolean

id

Long

int64

name

String

stringValue

String

trapDoor

Boolean

value

Long

int64

.2.733. GrantedAuthority

Field Name Required Type Description Format

authority

String

.2.734. Group

Field Name Required Type Description Format

accountNumberRequiresAutoGeneration

Boolean

activationLocalDate

date

date

active

Boolean

activeClientMembers

Set of Section .2.16

center

Boolean

childGroup

Boolean

clientMembers

Set of Section .2.16

closed

Boolean

group

Boolean

groupLevel

GroupLevel

groupMembers

List of Section .2.734

id

Long

int64

new

Boolean

notActive

Boolean

notPending

Boolean

office

Office

parent

Group

pending

Boolean

staff

Staff

submittedOnDate

date

date

transferInProgress

Boolean

transferInProgressOrOnHold

Boolean

transferOnHold

Boolean

.2.735. GroupLevel

Field Name Required Type Description Format

center

Boolean

group

Boolean

id

Long

int64

levelName

String

new

Boolean

parentId

Long

int64

recursable

Boolean

superParent

Boolean

.2.736. Grouping

Field Name Required Type Description Format

entities

List of Section .2.71

name

String

Field Name Required Type Description Format

name

String

value

String

.2.738. HookTemplateData

Field Name Required Type Description Format

serviceId

Long

int64

.2.739. IdDocument

Field Name Required Type Description Format

idNumber

String

idType

String

issuerCountry

String

otherIdDescription

String

.2.740. Image

Field Name Required Type Description Format

id

Long

int64

location

String

new

Boolean

storageType

Integer

int32

.2.741. InteropAccountData

Field Name Required Type Description Format

changes

Map of [object]

clientId

Long

int64

creditReport

Map of [object]

glimId

Long

int64

groupId

Long

int64

gsimId

Long

int64

loanId

Long

int64

officeId

Long

int64

productId

Long

int64

rollbackTransaction

Boolean

savingsId

Long

int64

subResourceId

Long

int64

transactionId

String

.2.742. InteropIdentifierAccountResponseData

Field Name Required Type Description Format

accountId

X

String

changes

Map of [object]

clientId

Long

int64

creditReport

Map of [object]

glimId

Long

int64

groupId

Long

int64

gsimId

Long

int64

loanId

Long

int64

officeId

Long

int64

productId

Long

int64

rollbackTransaction

Boolean

savingsId

Long

int64

subResourceId

Long

int64

transactionId

String

.2.743. InteropIdentifierRequestData

Field Name Required Type Description Format

accountId

X

String

idType

X

String

Enum: MSISDN, EMAIL, PERSONAL_ID, BUSINESS, DEVICE, ACCOUNT_ID, IBAN, ALIAS,

idValue

X

String

subIdOrType

String

.2.744. InteropIdentifiersResponseData

Field Name Required Type Description Format

changes

Map of [object]

clientId

Long

int64

creditReport

Map of [object]

glimId

Long

int64

groupId

Long

int64

gsimId

Long

int64

loanId

Long

int64

officeId

Long

int64

productId

Long

int64

rollbackTransaction

Boolean

savingsId

Long

int64

subResourceId

Long

int64

transactionId

String

.2.745. InteropKycResponseData

Field Name Required Type Description Format

birthCountry

String

changes

Map of [object]

clientId

Long

int64

contactPhone

String

creditReport

Map of [object]

dateOfBirth

String

emailAddress

String

gender

String

glimId

Long

int64

groupId

Long

int64

gsimId

Long

int64

idDocument

List of Section .2.739

loanId

Long

int64

nationality

String

officeId

Long

int64

postalAddress

PostalAddress

productId

Long

int64

rollbackTransaction

Boolean

savingsId

Long

int64

subResourceId

Long

int64

subjectName

SubjectName

transactionId

String

.2.746. InteropQuoteRequestData

Field Name Required Type Description Format

accountId

X

String

amount

X

MoneyData

amountType

X

String

Enum: SEND, RECEIVE,

expiration

Date

date-time

expirationLocalDate

date

date

extensionList

List of Section .2.74

fees

MoneyData

geoCode

GeoCodeData

note

String

quoteCode

X

String

requestCode

String

transactionCode

X

String

transactionRole

X

String

Enum: PAYER, PAYEE,

transactionType

InteropTransactionTypeData

.2.747. InteropQuoteResponseData

Field Name Required Type Description Format

changes

Map of [object]

clientId

Long

int64

creditReport

Map of [object]

expiration

String

extensionList

List of Section .2.74

fspCommission

MoneyData

fspFee

MoneyData

glimId

Long

int64

groupId

Long

int64

gsimId

Long

int64

loanId

Long

int64

officeId

Long

int64

productId

Long

int64

quoteCode

X

String

rollbackTransaction

Boolean

savingsId

Long

int64

state

X

String

Enum: ACCEPTED, REJECTED,

subResourceId

Long

int64

transactionCode

X

String

transactionId

String

.2.748. InteropTransactionRequestData

Field Name Required Type Description Format

accountId

X

String

amount

X

MoneyData

expiration

Date

date-time

expirationLocalDate

date

date

extensionList

List of Section .2.74

geoCode

GeoCodeData

note

String

requestCode

String

transactionCode

X

String

transactionRole

X

String

Enum: PAYER, PAYEE,

transactionType

InteropTransactionTypeData

.2.749. InteropTransactionRequestResponseData

Field Name Required Type Description Format

changes

Map of [object]

clientId

Long

int64

creditReport

Map of [object]

expiration

String

extensionList

List of Section .2.74

glimId

Long

int64

groupId

Long

int64

gsimId

Long

int64

loanId

Long

int64

officeId

Long

int64

productId

Long

int64

requestCode

X

String

rollbackTransaction

Boolean

savingsId

Long

int64

state

X

String

Enum: ACCEPTED, REJECTED,

subResourceId

Long

int64

transactionCode

X

String

transactionId

String

.2.750. InteropTransactionTypeData

Field Name Required Type Description Format

initiator

X

String

Enum: PAYER, PAYEE,

initiatorType

X

String

Enum: CONSUMER, AGENT, BUSINESS, DEVICE,

scenario

X

String

Enum: DEPOSIT, WITHDRAWAL, TRANSFER, PAYMENT, REFUND,

subScenario

String

.2.751. InteropTransactionsData

Field Name Required Type Description Format

changes

Map of [object]

clientId

Long

int64

creditReport

Map of [object]

glimId

Long

int64

groupId

Long

int64

gsimId

Long

int64

loanId

Long

int64

officeId

Long

int64

productId

Long

int64

rollbackTransaction

Boolean

savingsId

Long

int64

subResourceId

Long

int64

transactionId

String

.2.752. InteropTransferRequestData

Field Name Required Type Description Format

accountId

X

String

amount

X

MoneyData

expiration

Date

date-time

expirationLocalDate

date

date

extensionList

List of Section .2.74

fspCommission

MoneyData

fspFee

MoneyData

geoCode

GeoCodeData

note

String

requestCode

String

transactionCode

X

String

transactionRole

X

String

Enum: PAYER, PAYEE,

transactionType

InteropTransactionTypeData

transferCode

X

String

.2.753. InteropTransferResponseData

Field Name Required Type Description Format

changes

Map of [object]

clientId

Long

int64

completedTimestamp

String

creditReport

Map of [object]

expiration

String

extensionList

List of Section .2.74

glimId

Long

int64

groupId

Long

int64

gsimId

Long

int64

loanId

Long

int64

officeId

Long

int64

productId

Long

int64

rollbackTransaction

Boolean

savingsId

Long

int64

state

X

String

Enum: ACCEPTED, REJECTED,

subResourceId

Long

int64

transactionCode

X

String

transactionId

String

transferCode

X

String

.2.754. JobDetailHistoryDataSwagger

Field Name Required Type Description Format

jobRunEndTime

Date

date-time

jobRunStartTime

Date

date-time

status

String

triggerType

String

version

Long

int64

.2.755. JournalEntryCommand

Field Name Required Type Description Format

accountNumber

String

accountingRuleId

Long

int64

amount

BigDecimal

bankNumber

String

checkNumber

String

comments

String

credits

List of Section .2.1174

currencyCode

String

debits

List of Section .2.1174

officeId

Long

int64

paymentTypeId

Long

int64

receiptNumber

String

referenceNumber

String

routingCode

String

transactionDate

date

date

.2.756. JournalEntryData

Field Name Required Type Description Format

amount

BigDecimal

createdDate

date

date

currencyCode

String

entityId

Long

int64

entityType

EnumOptionData

entryType

EnumOptionData

glAccountId

Long

int64

glAccountType

EnumOptionData

id

Long

int64

manualEntry

Boolean

officeId

Long

int64

paymentTypeId

Long

int64

rowIndex

Integer

int32

savingTransactionId

Long

int64

transactionDate

date

date

transactionId

String

.2.757. LoanProduct

Field Name Required Type Description Format

accountingDisabled

Boolean

accountingType

Integer

int32

accrualBasedAccountingEnabled

Boolean

allowApprovedDisbursedAmountsOverApplied

Boolean

arrearsBasedOnOriginalSchedule

Boolean

cashBasedAccountingEnabled

Boolean

closeDate

date

date

currency

MonetaryCurrency

disallowExpectedDisbursements

Boolean

equalAmortization

Boolean

externalId

String

fixedPrincipalPercentagePerInstallment

BigDecimal

floatingRates

LoanProductFloatingRates

holdGuaranteeFundsEnabled

Boolean

id

Long

int64

includeInBorrowerCycle

Boolean

installmentAmountInMultiplesOf

Integer

int32

interestPeriodFrequencyType

String

Enum: DAYS, WEEKS, MONTHS, YEARS, WHOLE_TERM, INVALID,

interestRecalculationEnabled

Boolean

linkedToFloatingInterestRate

Boolean

loanProducTrancheDetails

LoanProductTrancheDetails

loanProductCharges

List of Section .2.13

loanProductConfigurableAttributes

LoanProductConfigurableAttributes

loanProductGuaranteeDetails

LoanProductGuaranteeDetails

loanProductRelatedDetail

LoanProductRelatedDetail

maxNominalInterestRatePerPeriod

BigDecimal

maxNumberOfRepayments

Integer

int32

maxPrincipalAmount

Money

minNominalInterestRatePerPeriod

BigDecimal

minNumberOfRepayments

Integer

int32

minPrincipalAmount

Money

minimumDaysBetweenDisbursalAndFirstRepayment

Integer

int32

multiDisburseLoan

Boolean

new

Boolean

nominalInterestRatePerPeriod

BigDecimal

numberOfRepayments

Integer

int32

overAppliedCalculationType

String

overAppliedNumber

Integer

int32

periodicAccrualAccountingEnabled

Boolean

principalAmount

Money

principalThresholdForLastInstallment

BigDecimal

productInterestRecalculationDetails

LoanProductInterestRecalculationDetails

rates

List of Section .2.1160

repaymentStrategy

LoanTransactionProcessingStrategy

shortName

String

startDate

date

date

syncExpectedWithDisbursementDate

Boolean

upfrontAccrualAccountingEnabled

Boolean

.2.758. LoanProductBorrowerCycleVariationData

Field Name Required Type Description Format

borrowerCycleNumber

Integer

int32

defaultValue

BigDecimal

paramType

String

Enum: INVALID, PRINCIPAL, INTERESTRATE, REPAYMENT,

valueConditionType

String

Enum: INVALID, EQUAL, GREATERTHAN,

.2.759. LoanProductConfigurableAttributes

Field Name Required Type Description Format

amortizationBoolean

Boolean

amortizationType

Boolean

arrearsToleranceBoolean

Boolean

graceOnArrearsAgeing

Boolean

graceOnArrearsAgingBoolean

Boolean

graceOnPrincipalAndInterestPayment

Boolean

graceOnPrincipalAndInterestPaymentBoolean

Boolean

id

Long

int64

inArrearsTolerance

Boolean

interestCalcPeriodBoolean

Boolean

interestCalculationPeriodType

Boolean

interestMethodBoolean

Boolean

interestType

Boolean

loanProduct

LoanProduct

new

Boolean

repaymentEvery

Boolean

repaymentEveryBoolean

Boolean

transactionProcessingStrategyBoolean

Boolean

transactionProcessingStrategyId

Boolean

.2.760. LoanProductData

Field Name Required Type Description Format

allowPartialPeriodInterestCalcualtion

Boolean

amortizationType

EnumOptionData

amortizationTypeOptions

List of Section .2.72

annualInterestRate

BigDecimal

chargeOptions

List of Section .2.14

closeDate

date

date

compoundingToBePostedAsTransaction

Boolean

currency

CurrencyData

daysInMonthType

EnumOptionData

daysInYearType

EnumOptionData

defaultDifferentialLendingRate

BigDecimal

description

String

equalAmortization

Boolean

fixedPrincipalPercentagePerInstallment

BigDecimal

floatingInterestRateCalculationAllowed

Boolean

fundId

Long

int64

fundName

String

fundOptions

List of Section .2.82

getloanProductConfigurableAttributes

LoanProductConfigurableAttributes

graceOnArrearsAgeing

Integer

int32

graceOnInterestCharged

Integer

int32

graceOnInterestPayment

Integer

int32

graceOnPrincipalPayment

Integer

int32

id

Long

int64

inArrearsTolerance

BigDecimal

interestCalculationPeriodType

EnumOptionData

interestCalculationPeriodTypeOptions

List of Section .2.72

interestRateDifferential

BigDecimal

interestRateFrequencyType

EnumOptionData

interestRateFrequencyTypeOptions

List of Section .2.72

interestRatePerPeriod

BigDecimal

interestRateVariationsForBorrowerCycle

List of Section .2.758

interestRecalculationData

LoanProductInterestRecalculationData

interestRecalculationEnabled

Boolean

interestType

EnumOptionData

interestTypeOptions

List of Section .2.72

linkedToFloatingInterestRates

Boolean

maxDifferentialLendingRate

BigDecimal

maxInterestRatePerPeriod

BigDecimal

maxNumberOfRepayments

Integer

int32

maxPrincipal

BigDecimal

maximumGapBetweenInstallments

Integer

int32

minDifferentialLendingRate

BigDecimal

minInterestRatePerPeriod

BigDecimal

minNumberOfRepayments

Integer

int32

minPrincipal

BigDecimal

minimumGapBetweenInstallments

Integer

int32

multiDisburseLoan

Boolean

name

String

numberOfRepaymentVariationsForBorrowerCycle

List of Section .2.758

numberOfRepayments

Integer

int32

outstandingLoanBalance

BigDecimal

principal

BigDecimal

principalVariationsForBorrowerCycle

List of Section .2.758

recurringMoratoriumOnPrincipalPeriods

Integer

int32

repaymentEvery

Integer

int32

repaymentFrequencyType

EnumOptionData

repaymentFrequencyTypeOptions

List of Section .2.72

startDate

date

date

transactionProcessingStrategyId

Long

int64

transactionProcessingStrategyName

String

variableInstallmentsAllowed

Boolean

.2.761. LoanProductFloatingRates

Field Name Required Type Description Format

defaultDifferentialLendingRate

BigDecimal

floatingInterestRateCalculationAllowed

Boolean

floatingRate

FloatingRate

id

Long

int64

interestRateDifferential

BigDecimal

loanProduct

LoanProduct

maxDifferentialLendingRate

BigDecimal

minDifferentialLendingRate

BigDecimal

new

Boolean

.2.762. LoanProductGuaranteeDetails

Field Name Required Type Description Format

id

Long

int64

mandatoryGuarantee

BigDecimal

minimumGuaranteeFromGuarantor

BigDecimal

minimumGuaranteeFromOwnFunds

BigDecimal

new

Boolean

.2.763. LoanProductInterestRecalculationData

Field Name Required Type Description Format

compoundingToBePostedAsTransaction

Boolean

interestRecalculationCompoundingType

EnumOptionData

recalculationCompoundingFrequencyInterval

Integer

int32

recalculationCompoundingFrequencyNthDay

EnumOptionData

recalculationCompoundingFrequencyOnDay

Integer

int32

recalculationCompoundingFrequencyType

EnumOptionData

recalculationCompoundingFrequencyWeekday

EnumOptionData

recalculationRestFrequencyInterval

Integer

int32

recalculationRestFrequencyNthDay

EnumOptionData

recalculationRestFrequencyOnDay

Integer

int32

recalculationRestFrequencyType

EnumOptionData

recalculationRestFrequencyWeekday

EnumOptionData

rescheduleStrategyType

EnumOptionData

.2.764. LoanProductInterestRecalculationDetails

Field Name Required Type Description Format

arrearsBasedOnOriginalSchedule

Boolean

compoundingFrequencyNthDay

Integer

int32

compoundingFrequencyOnDay

Integer

int32

compoundingFrequencyType

String

Enum: INVALID, SAME_AS_REPAYMENT_PERIOD, DAILY, WEEKLY, MONTHLY,

compoundingFrequencyWeekday

Integer

int32

compoundingInterval

Integer

int32

id

Long

int64

interestRecalculationCompoundingMethod

Integer

int32

isCompoundingToBePostedAsTransaction

Boolean

new

Boolean

rescheduleStrategyMethod

Integer

int32

restFrequencyNthDay

Integer

int32

restFrequencyOnDay

Integer

int32

restFrequencyType

String

Enum: INVALID, SAME_AS_REPAYMENT_PERIOD, DAILY, WEEKLY, MONTHLY,

restFrequencyWeekday

Integer

int32

restInterval

Integer

int32

.2.765. LoanProductProvisioningEntryData

Field Name Required Type Description Format

amountreserved

BigDecimal

balance

BigDecimal

categoryId

Long

int64

categoryName

String

criteriaId

Long

int64

currencyCode

String

expenseAccount

Long

int64

expenseAccountCode

String

expenseAccountName

String

historyId

Long

int64

liabilityAccountCode

String

liabilityAccountName

String

liablityAccount

Long

int64

officeId

Long

int64

officeName

String

overdueInDays

Long

int64

percentage

BigDecimal

productId

Long

int64

productName

String

.2.766. LoanProductRelatedDetail

Field Name Required Type Description Format

allowPartialPeriodInterestCalcualtion

Boolean

amortizationMethod

String

Enum: EQUAL_PRINCIPAL, EQUAL_INSTALLMENTS, INVALID,

annualNominalInterestRate

BigDecimal

arrearsTolerance

BigDecimal

currency

MonetaryCurrency

equalAmortization

Boolean

graceOnArrearsAgeing

Integer

int32

graceOnDueDate

Integer

int32

graceOnInterestPayment

Integer

int32

graceOnPrincipalPayment

Integer

int32

inArrearsTolerance

Money

interestCalculationPeriodMethod

String

Enum: DAILY, SAME_AS_REPAYMENT_PERIOD, INVALID,

interestMethod

String

Enum: DECLINING_BALANCE, FLAT, INVALID,

interestPeriodFrequencyType

String

Enum: DAYS, WEEKS, MONTHS, YEARS, WHOLE_TERM, INVALID,

interestRecalculationEnabled

Boolean

nominalInterestRatePerPeriod

BigDecimal

numberOfRepayments

Integer

int32

principal

Money

repayEvery

Integer

int32

repaymentPeriodFrequencyType

String

Enum: DAYS, WEEKS, MONTHS, YEARS, WHOLE_TERM, INVALID,

.2.767. LoanProductTrancheDetails

Field Name Required Type Description Format

multiDisburseLoan

Boolean

.2.768. LoanTransactionProcessingStrategy

Field Name Required Type Description Format

creocoreStrategy

Boolean

earlyPaymentStrategy

Boolean

heavensfamilyStrategy

Boolean

id

Long

int64

indianRBIStrategy

Boolean

interestPrincipalPenaltiesFeesOrderStrategy

Boolean

new

Boolean

principalInterestPenaltiesFeesOrderStrategy

Boolean

standardStrategy

Boolean

.2.769. LookupTableData

Field Name Required Type Description Format

description

String

entries

List of Section .2.770

key

String

.2.770. LookupTableEntry

Field Name Required Type Description Format

score

Double

double

valueFrom

Integer

int32

valueTo

Integer

int32

.2.771. MonetaryCurrency

Field Name Required Type Description Format

code

String

currencyInMultiplesOf

Integer

int32

digitsAfterDecimal

Integer

int32

.2.772. Money

Field Name Required Type Description Format

amount

BigDecimal

amountDefaultedToNullIfZero

BigDecimal

currency

MonetaryCurrency

currencyCode

String

currencyDigitsAfterDecimal

Integer

int32

currencyInMultiplesOf

Integer

int32

greaterThanZero

Boolean

lessThanZero

Boolean

zero

Boolean

.2.773. MoneyData

Field Name Required Type Description Format

amount

X

BigDecimal

currency

X

String

.2.774. MultiPart

Field Name Required Type Description Format

bodyParts

List of Section .2.7

contentDisposition

ContentDisposition

entity

Object

headers

Map of [array]

mediaType

BodyPart_mediaType

messageBodyWorkers

Object

parameterizedHeaders

Map of [array]

parent

MultiPart

providers

Object

.2.775. Office

Field Name Required Type Description Format

hierarchy

String

id

Long

int64

name

String

new

Boolean

openingLocalDate

date

date

parent

Office

.2.776. OfficeData

Field Name Required Type Description Format

hierarchy

String

id

Long

int64

openingDate

date

date

rowIndex

Integer

int32

.2.777. PageCashierTransactionData

Field Name Required Type Description Format

pageItems

List of Section .2.10

totalFilteredRecords

Integer

int32

.2.778. ParameterizedHeader

Field Name Required Type Description Format

parameters

Map of [string]

value

String

.2.779. PaymentType

Field Name Required Type Description Format

cashPayment

Boolean

id

Long

int64

new

Boolean

paymentName

String

.2.780. Permission

Field Name Required Type Description Format

code

String

grouping

String

id

Long

int64

new

Boolean

.2.781. PostAccountNumberFormatsRequest

PostAccountNumberFormatsRequest

Field Name Required Type Description Format

accountType

Long

int64

prefixType

Long

int64

.2.782. PostAccountNumberFormatsResponse

PostAccountNumberFormatsResponse

Field Name Required Type Description Format

resourceId

Long

int64

.2.783. PostAccountTransfersRefundByTransferRequest

PostAccountTransfersRefundByTransferRequest

Field Name Required Type Description Format

dateFormat

String

fromAccountId

Integer

int32

fromAccountType

Integer

int32

fromClientId

Integer

int32

fromOfficeId

Integer

int32

locale

String

toAccountId

Integer

int32

toAccountType

Integer

int32

toClientId

Integer

int32

toOfficeId

Integer

int32

transferAmount

Float

float

transferDate

String

transferDescription

String

.2.784. PostAccountTransfersRefundByTransferResponse

PostAccountTransfersRefundByTransferResponse

Field Name Required Type Description Format

resourceId

Integer

int32

savingsId

Integer

int32

.2.785. PostAccountTransfersRequest

PostAccountTransfersRequest

Field Name Required Type Description Format

dateFormat

String

fromAccountId

Integer

int32

fromAccountType

Integer

int32

fromClientId

Integer

int32

fromOfficeId

Integer

int32

locale

String

toAccountId

Integer

int32

toAccountType

Integer

int32

toClientId

Integer

int32

toOfficeId

Integer

int32

transferAmount

Float

float

transferDate

String

transferDescription

String

.2.786. PostAccountTransfersResponse

PostAccountTransfersResponse

Field Name Required Type Description Format

resourceId

Integer

int32

savingsId

Integer

int32

.2.787. PostAccountingRulesRequest

PostAccountingRulesRequest

Field Name Required Type Description Format

accountToCredit

Long

int64

accountToDebit

Long

int64

description

String

name

String

officeId

Long

int64

.2.788. PostAccountingRulesResponse

PostAccountingRulesResponse

Field Name Required Type Description Format

officeId

Long

int64

resourceId

Long

int64

.2.789. PostAccountsCharges

Field Name Required Type Description Format

amount

Integer

int32

chargeId

Integer

int32

.2.790. PostAccountsRequestedShares

Field Name Required Type Description Format

id

Integer

int32

.2.791. PostAccountsTypeAccountIdRequest

PostAccountsTypeAccountIdRequest

Field Name Required Type Description Format

requestedShares

Set of Section .2.790

.2.792. PostAccountsTypeAccountIdResponse

PostAccountsTypeAccountIdResponse

Field Name Required Type Description Format

resourceId

Integer

int32

.2.793. PostAccountsTypeRequest

PostAccountsTypeRequest

Field Name Required Type Description Format

allowDividendCalculationForInactiveClients

Boolean

applicationDate

String

charges

Set of Section .2.789

clientId

Integer

int32

dateFormat

String

externalId

Integer

int32

locale

String

lockinPeriodFrequency

Integer

int32

lockinPeriodFrequencyType

Integer

int32

minimumActivePeriod

Integer

int32

minimumActivePeriodFrequencyType

Integer

int32

productId

Integer

int32

requestedShares

Integer

int32

savingsAccountId

Integer

int32

submittedDate

String

.2.794. PostAccountsTypeResponse

PostAccountsTypeResponse

Field Name Required Type Description Format

resourceId

Integer

int32

.2.795. PostAdhocQuerySearchRequest

PostAdhocQuerySearchRequest

Field Name Required Type Description Format

dateFormat

String

includeOutStandingAmountPercentage

Boolean

includeOutstandingAmount

Boolean

loanDateOption

String

loanFromDate

date

date

loanToDate

date

date

locale

String

maxOutstandingAmount

Long

int64

minOutstandingAmount

Long

int64

outStandingAmountPercentage

Long

int64

outStandingAmountPercentageCondition

String

outstandingAmountCondition

String

.2.796. PostAdhocQuerySearchResponse

PostAdhocQuerySearchResponse

Field Name Required Type Description Format

loanOutStanding

Long

int64

loanProductName

String

officeName

String

percentage

Long

int64

.2.797. PostAuthenticationRequest

PostAuthenticationRequest

Field Name Required Type Description Format

password

X

String

username

X

String

.2.798. PostAuthenticationResponse

PostAuthenticationResponse

Field Name Required Type Description Format

authenticated

Boolean

base64EncodedAuthenticationKey

String

officeId

Long

int64

officeName

String

organisationalRole

EnumOptionData

permissions

List of [string]

roles

List of Section .2.1168

staffDisplayName

String

staffId

Long

int64

userId

Long

int64

username

String

.2.799. PostBatchesRequest

PostBatchesRequest

Field Name Required Type Description Format

body

PostBodyRequestSwagger

headers

Set of Section .2.737

method

String

reference

Long

int64

relativeUrl

String

requestId

Long

int64

.2.800. PostBodyRequestSwagger

Field Name Required Type Description Format

activationDate

String

active

Boolean

dateFormat

String

externalId

String

firstname

String

lastname

String

locale

String

officeId

Long

int64

submittedOnDate

String

.2.801. PostCentersCenterIdRequest

PostCentersCenterIdRequest

Field Name Required Type Description Format

closureDate

String

closureReasonId

Integer

int32

dateFormat

String

locale

String

.2.802. PostCentersCenterIdResponse

PostCentersCenterIdResponse

Field Name Required Type Description Format

resourceId

Integer

int32

.2.803. PostCentersRequest

PostCentersRequest

Field Name Required Type Description Format

active

Boolean

name

String

officeId

Integer

int32

.2.804. PostCentersResponse

PostCentersResponse

Field Name Required Type Description Format

groupId

Integer

int32

officeId

Integer

int32

resourceId

Integer

int32

.2.805. PostChargesRequest

PostChargesRequest

Field Name Required Type Description Format

active

String

amount

Float

float

chargeAppliesTo

Integer

int32

chargeCalculationType

Integer

int32

chargePaymentMode

Integer

int32

chargeTimeType

Integer

int32

currencyCode

String

locale

String

name

String

.2.806. PostChargesResponse

PostChargesResponse

Field Name Required Type Description Format

resourceId

Integer

int32

.2.807. PostClientClientIdAddressesRequest

PostClientClientIdAddressesRequest

Field Name Required Type Description Format

addressLine1

String

addressLine2

String

addressLine3

String

city

String

countryId

Integer

int32

isActive

Boolean

postalCode

Long

int64

stateProvinceId

Integer

int32

street

String

.2.808. PostClientClientIdAddressesResponse

PostClientClientIdAddressesResponse

Field Name Required Type Description Format

resourceId

Integer

int32

.2.809. PostClientCollateralRequest

PostClientCollateralRequest

Field Name Required Type Description Format

collateralId

Long

int64

locale

String

quantity

BigDecimal

.2.810. PostClientCollateralResponse

PostClientCollateralResponse

Field Name Required Type Description Format

clientId

Integer

int32

resourceId

Integer

int32

.2.811. PostClientsAddressRequest

Address requests

Field Name Required Type Description Format

addressLine1

String

addressLine2

String

addressLine3

String

addressTypeId

Long

int64

city

String

countryId

Integer

int32

isActive

Boolean

postalCode

Long

int64

stateProvinceId

Integer

int32

street

String

.2.812. PostClientsClientIdChargesChargeIdRequest

PostClientsClientIdChargesChargeIdRequest

Field Name Required Type Description Format

amount

Integer

int32

dateFormat

String

locale

String

transactionDate

String

.2.813. PostClientsClientIdChargesChargeIdResponse

PostClientsClientIdChargesChargeIdResponse

Field Name Required Type Description Format

clientId

Integer

int32

officeId

Integer

int32

resourceId

Integer

int32

transactionId

Integer

int32

.2.814. PostClientsClientIdChargesRequest

PostClientsClientIdChargesRequest

Field Name Required Type Description Format

amount

Integer

int32

chargeId

Integer

int32

dateFormat

String

dueDate

String

locale

String

.2.815. PostClientsClientIdChargesResponse

PostClientsClientIdChargesResponse

Field Name Required Type Description Format

chargeId

Integer

int32

officeId

Integer

int32

resourceId

Integer

int32

.2.816. PostClientsClientIdIdentifiersRequest

PostClientsClientIdIdentifiersRequest

Field Name Required Type Description Format

description

String

documentKey

String

documentTypeId

Integer

int32

.2.817. PostClientsClientIdIdentifiersResponse

PostClientsClientIdIdentifiersResponse

Field Name Required Type Description Format

clientId

Integer

int32

officeId

Integer

int32

resourceId

Integer

int32

.2.818. PostClientsClientIdRequest

PostClientsClientIdRequest

Field Name Required Type Description Format

activationDate

String

dateFormat

String

locale

String

.2.819. PostClientsClientIdResponse

PostClientsClientIdResponse

Field Name Required Type Description Format

clientId

Integer

int32

officeId

Integer

int32

resourceId

Integer

int32

.2.820. PostClientsClientIdTransactionsTransactionIdResponse

PostClientsClientIdTransactionsTransactionIdResponse

Field Name Required Type Description Format

clientId

Integer

int32

officeId

Integer

int32

resourceId

Integer

int32

.2.821. PostClientsDatatable

List of PostClientsDatatable

Field Name Required Type Description Format

data

Map of [object]

registeredTableName

String

.2.822. PostClientsRequest

PostClientsRequest

Field Name Required Type Description Format

activationDate

String

active

Boolean

address

List of Section .2.811

Address requests

datatables

List of Section .2.821

List of PostClientsDatatable

dateFormat

String

externalId

String

firstname

String

fullname

String

groupId

Integer

int32

lastname

String

legalFormId

Integer

int32

locale

String

officeId

Integer

int32

.2.823. PostClientsResponse

PostClientsResponse

Field Name Required Type Description Format

clientId

Long

int64

groupId

Integer

int32

officeId

Integer

int32

resourceId

Integer

int32

.2.824. PostCodeValueDataResponse

PostCodeValueDataResponse

Field Name Required Type Description Format

resourceId

Long

int64

.2.825. PostCodeValuesDataRequest

PostCodeValuesDataRequest

Field Name Required Type Description Format

description

String

name

String

position

Integer

int32

.2.826. PostCodesRequest

PostCodesRequest

Field Name Required Type Description Format

name

String

.2.827. PostCodesResponse

PostCodesResponse

Field Name Required Type Description Format

resourceId

Long

int64

.2.828. PostCollateralManagementProductRequest

PostCollateralManagementProductRequest

Field Name Required Type Description Format

basePrice

BigDecimal

currency

String

name

String

pctToBase

BigDecimal

quality

String

unitType

String

.2.829. PostCollateralManagementProductResponse

PostCollateralManagementProductResponse

Field Name Required Type Description Format

resourceId

Integer

int32

.2.830. PostCollectionSheetBulkRepaymentTransactions

Field Name Required Type Description Format

loanId

Integer

int32

paymentTypeId

Integer

int32

receiptNumber

Long

int64

transactionAmount

Double

double

.2.831. PostCollectionSheetChanges

Field Name Required Type Description Format

SavingsTransactions

List of [integer]

int32

dateFormat

String

loanTransactions

List of [integer]

int32

locale

String

.2.832. PostCollectionSheetRequest

PostCollectionSheetRequest

Field Name Required Type Description Format

actualDisbursementDate

String

bulkDisbursementTransactions

List of [integer]

int32

bulkRepaymentTransactions

PostCollectionSheetBulkRepaymentTransactions

bulkSavingsDueTransactions

List of [integer]

int32

dateFormat

String

locale

String

transactionDate

String

.2.833. PostCollectionSheetResponse

PostCollectionSheetResponse

Field Name Required Type Description Format

changes

PostCollectionSheetChanges

groupId

Integer

int32

resourceId

Integer

int32

.2.834. PostColumnHeaderData

Field Name Required Type Description Format

code

String

Used in Code Value fields. Column name becomes: code_cd_name. Mandatory if using type Dropdown, otherwise an error is returned.

length

Long

Length of the text field. Mandatory if type String is used, otherwise an error is returned.

int64

mandatory

Boolean

Defaults to false

name

X

String

type

X

String

Any of them: Boolean

Date

DateTime

Decimal

Dropdown

Number

String

.2.835. PostDataTablesAppTableIdResponse

PostDataTablesAppTableIdResponse

Field Name Required Type Description Format

resourceId

Long

int64

.2.836. PostDataTablesRequest

PostDataTablesRequest

Field Name Required Type Description Format

apptableName

X

String

columns

X

List of Section .2.834

datatableName

X

String

multiRow

Boolean

Allows to create multiple entries in the Data Table. Optional, defaults to false. If this property is not provided Data Table will allow only one entry.

.2.837. PostDataTablesResponse

PostDataTablesResponse

Field Name Required Type Description Format

resourceIdentifier

String

.2.838. PostEntityDatatableChecksTemplateRequest

PostEntityDatatableChecksTemplateRequest

Field Name Required Type Description Format

datatableName

String

entity

String

productId

Long

int64

status

Long

int64

.2.839. PostEntityDatatableChecksTemplateResponse

PostEntityDatatableChecksTemplateResponse

Field Name Required Type Description Format

resourceId

Long

int64

.2.840. PostEntityTypeEntityIdDocumentsResponse

PostEntityTypeEntityIdDocumentsResponse

Field Name Required Type Description Format

resourceId

Long

int64

resourceIdentifier

String

.2.841. PostFinancialActivityAccountsRequest

PostFinancialActivityAccountsRequest

Field Name Required Type Description Format

financialActivityId

Long

int64

glAccountId

Long

int64

.2.842. PostFinancialActivityAccountsResponse

PostFinancialActivityAccountsResponse

Field Name Required Type Description Format

resourceId

Long

int64

.2.843. PostFixedDepositAccountsAccountIdResponse

PostFixedDepositAccountsAccountIdResponse

Field Name Required Type Description Format

clientId

Integer

int32

officeId

Integer

int32

resourceId

Integer

int32

savingsId

Integer

int32

.2.844. PostFixedDepositAccountsRequest

PostFixedDepositAccountsRequest

Field Name Required Type Description Format

clientId

Integer

int32

dateFormat

String

depositAmount

Float

float

depositPeriod

Integer

int32

depositPeriodFrequencyId

Integer

int32

locale

String

productId

Integer

int32

submittedOnDate

String

.2.845. PostFixedDepositAccountsResponse

PostFixedDepositAccountsResponse

Field Name Required Type Description Format

clientId

Integer

int32

officeId

Integer

int32

resourceId

Integer

int32

savingsId

Integer

int32

.2.846. PostFixedDepositProductsChartSlabs

Field Name Required Type Description Format

annualInterestRate

Double

double

description

String

fromPeriod

Integer

int32

periodType

Integer

int32

toPeriod

Integer

int32

.2.847. PostFixedDepositProductsCharts

Field Name Required Type Description Format

chartSlabs

Set of Section .2.846

dateFormat

String

fromDate

String

locale

String

.2.848. PostFixedDepositProductsRequest

PostFixedDepositProductsRequest

Field Name Required Type Description Format

accountingRule

Integer

int32

charts

Set of Section .2.847

currencyCode

String

description

String

digitsAfterDecimal

Integer

int32

inMultiplesOf

Integer

int32

interestCalculationDaysInYearType

Integer

int32

interestCalculationType

Integer

int32

interestCompoundingPeriodType

Integer

int32

interestPostingPeriodType

Integer

int32

locale

String

maxDepositTerm

Integer

int32

maxDepositTermTypeId

Integer

int32

minDepositTerm

Integer

int32

minDepositTermTypeId

Integer

int32

name

String

preClosurePenalApplicable

Boolean

preClosurePenalInterest

Double

double

preClosurePenalInterestOnTypeId

Integer

int32

shortName

String

.2.849. PostFixedDepositProductsResponse

PostFixedDepositProductsResponse

Field Name Required Type Description Format

resourceId

Integer

int32

.2.850. PostFloatingRatesRatePeriods

Field Name Required Type Description Format

dateFormat

String

fromDate

String

interestRate

Double

double

locale

String

.2.851. PostFloatingRatesRequest

PostFloatingRatesRequest

Field Name Required Type Description Format

isActive

Boolean

isBaseLendingRate

Boolean

name

String

ratePeriods

Set of Section .2.850

.2.852. PostFloatingRatesResponse

PostFloatingRatesResponse

Field Name Required Type Description Format

resourceId

Integer

int32

.2.853. PostFundsRequest

PostFundsRequest

Field Name Required Type Description Format

name

String

.2.854. PostFundsResponse

PostFundsResponse

Field Name Required Type Description Format

resourceId

Integer

int32

.2.855. PostGLAccountsRequest

PostGLAccountsRequest

Field Name Required Type Description Format

description

String

glCode

String

manualEntriesAllowed

Boolean

name

String

parentId

Long

int64

tagId

String

type

String

usage

EnumOptionData

.2.856. PostGLAccountsResponse

PostGLAccountsResponse

Field Name Required Type Description Format

resourceId

Integer

int32

.2.857. PostGlClosuresRequest

PostGLCLosuresRequest

Field Name Required Type Description Format

closingDate

date

date

comments

String

dateFormat

String

locale

String

officeId

Long

int64

.2.858. PostGlClosuresResponse

PostGlClosuresResponse

Field Name Required Type Description Format

officeId

Long

int64

resourceId

Long

int64

.2.859. PostGroupsGroupIdClients

Field Name Required Type Description Format

id

Integer

int32

.2.860. PostGroupsGroupIdCommandUnassignStaffRequest

PostGroupsGroupIdCommandUnassignStaffRequest

Field Name Required Type Description Format

staffId

Integer

int32

.2.861. PostGroupsGroupIdCommandUnassignStaffResponse

PostGroupsGroupIdCommandUnassignStaffResponse

Field Name Required Type Description Format

changes

Object

groupId

Integer

int32

officeId

Integer

int32

resourceId

Integer

int32

.2.862. PostGroupsGroupIdRequest

PostGroupsGroupIdRequest

Field Name Required Type Description Format

clients

Set of Section .2.859

destinationGroupId

Integer

int32

.2.863. PostGroupsGroupIdResponse

PostGroupsGroupIdResponse

Field Name Required Type Description Format

resourceId

Integer

int32

.2.864. PostGroupsRequest

PostGroupsRequest

Field Name Required Type Description Format

active

Boolean

name

String

officeId

Integer

int32

.2.865. PostGroupsResponse

PostGroupsResponse

Field Name Required Type Description Format

groupId

Integer

int32

officeId

Integer

int32

resourceId

Integer

int32

.2.866. PostHolidaysHolidayIdResponse

PostHolidaysHolidayIdResponse

Field Name Required Type Description Format

resourceId

Long

int64

.2.867. PostHolidaysRequest

PostHolidaysRequest

Field Name Required Type Description Format

dateFormat

String

description

String

fromDate

date

date

locale

String

name

String

offices

List of Section .2.868

repaymentsRescheduledTo

date

date

toDate

date

date

.2.868. PostHolidaysRequestOffices

Field Name Required Type Description Format

officeId

Long

int64

.2.869. PostHolidaysResponse

PostHolidaysResponse

Field Name Required Type Description Format

resourceId

Long

int64

.2.870. PostHookRequest

PostHookRequest

Field Name Required Type Description Format

config

List of Section .2.76

displayName

String

events

List of Section .2.73

isActive

Boolean

name

String

templateId

Long

int64

.2.871. PostHookResponse

PostHookResponse

Field Name Required Type Description Format

resourceId

Long

int64

.2.872. PostInterestRateChartsChartIdChartSlabsIncentives

Field Name Required Type Description Format

amount

Float

float

attributeName

Integer

int32

attributeValue

Integer

int32

conditionType

Integer

int32

entityType

Integer

int32

incentiveType

Integer

int32

.2.873. PostInterestRateChartsChartIdChartSlabsRequest

PostInterestRateChartsChartIdChartSlabsRequest

Field Name Required Type Description Format

annualInterestRate

Double

double

description

String

fromPeriod

Integer

int32

incentives

Set of Section .2.872

locale

String

periodType

Integer

int32

toPeriod

Integer

int32

.2.874. PostInterestRateChartsChartIdChartSlabsResponse

PostInterestRateChartsChartIdChartSlabsResponse

Field Name Required Type Description Format

resourceId

Integer

int32

.2.875. PostInterestRateChartsRequest

PostInterestRateChartsRequest

Field Name Required Type Description Format

dateFormat

String

description

String

fromDate

String

locale

String

name

String

type

String

.2.876. PostInterestRateChartsResponse

PostInterestRateChartsResponse

Field Name Required Type Description Format

resourceId

Integer

int32

.2.877. PostJournalEntriesResponse

PostJournalEntriesResponse

Field Name Required Type Description Format

officeId

Long

1

int64

transactionId

String

RS9MCISID4WK1ZM

.2.878. PostJournalEntriesTransactionIdRequest

PostJournalEntriesTransactionIdRequest

Field Name Required Type Description Format

officeId

Long

1

int64

.2.879. PostJournalEntriesTransactionIdResponse

PostJournalEntriesTransactionIdResponse

Field Name Required Type Description Format

officeId

Long

1

int64

.2.880. PostLinkDelinkAccountsToFromPocketResponse

PostLinkDelinkAccountsToFromPocketResponse

Field Name Required Type Description Format

resourceId

Integer

int32

.2.881. PostLoanChanges

Field Name Required Type Description Format

removedEntityIds

List of [integer]

int32

.2.882. PostLoanProductsRequest

PostLoanProductsRequest

Field Name Required Type Description Format

accountingRule

Integer

int32

amortizationType

Integer

int32

currencyCode

String

daysInMonthType

Integer

int32

daysInYearType

Integer

int32

digitsAfterDecimal

Integer

int32

fixedPrincipalPercentagePerInstallment

BigDecimal

fundSourceAccountId

Integer

int32

inMultiplesOf

Integer

int32

incomeFromFeeAccountId

Integer

int32

incomeFromPenaltyAccountId

Integer

int32

interestCalculationPeriodType

Integer

int32

interestOnLoanAccountId

Integer

int32

interestRateFrequencyType

Integer

int32

interestRatePerPeriod

Double

double

interestType

Integer

int32

isInterestRecalculationEnabled

Boolean

loanPortfolioAccountId

Integer

int32

locale

String

name

String

numberOfRepayments

Integer

int32

overpaymentLiabilityAccountId

Integer

int32

principal

Double

double

receivableFeeAccountId

Integer

int32

receivableInterestAccountId

Integer

int32

receivablePenaltyAccountId

Integer

int32

repaymentEvery

Integer

int32

repaymentFrequencyType

Integer

int32

shortName

String

transactionProcessingStrategyId

Integer

int32

writeOffAccountId

Integer

int32

.2.883. PostLoanProductsResponse

PostLoanProductsResponse

Field Name Required Type Description Format

resourceId

Integer

int32

.2.884. PostLoansLoanIdChargesChargeIdRequest

PostLoansLoanIdChargesChargeIdRequest

Field Name Required Type Description Format

dateFormat

String

locale

String

transactionDate

String

.2.885. PostLoansLoanIdChargesChargeIdResponse

PostLoansLoanIdChargesChargeIdResponse

Field Name Required Type Description Format

clientId

Long

int64

loanId

Long

int64

officeId

Long

int64

resourceId

Integer

int32

savingsId

Long

int64

.2.886. PostLoansLoanIdChargesRequest

PostLoansLoanIdChargesRequest
Field Name Required Type Description Format

amount

Float

float

chargeId

Integer

int32

dateFormat

String

dueDate

String

locale

String

.2.887. PostLoansLoanIdChargesResponse

PostLoansLoanIdChargesResponse
Field Name Required Type Description Format

clientId

Long

int64

loanId

Long

int64

officeId

Long

int64

resourceId

Integer

int32

.2.888. PostLoansLoanIdCollateralsRequest

PostLoansLoanIdCollateralsRequest

Field Name Required Type Description Format

collateralTypeId

Integer

int32

.2.889. PostLoansLoanIdCollateralsResponse

PostLoansLoanIdCollateralsResponse

Field Name Required Type Description Format

resourceId

Integer

int32

.2.890. PostLoansLoanIdRequest

PostLoansLoanIdRequest

Field Name Required Type Description Format

assignmentDate

String

dateFormat

String

fromLoanOfficerId

Integer

int32

locale

String

toLoanOfficerId

Integer

int32

.2.891. PostLoansLoanIdResponse

PostLoansLoanIdResponse

Field Name Required Type Description Format

clientId

Integer

int32

loanId

Integer

int32

officeId

Integer

int32

resourceId

Integer

int32

.2.892. PostLoansLoanIdScheduleResponse

PostLoansLoanIdScheduleResponse

Field Name Required Type Description Format

changes

PostLoanChanges

loanId

Integer

int32

.2.893. PostLoansLoanIdTransactionsResponse

PostLoansLoanIdTransactionsResponse

Field Name Required Type Description Format

clientId

Integer

int32

officeId

Integer

int32

resourceId

Integer

int32

.2.894. PostLoansLoanIdTransactionsTransactionIdRequest

PostLoansLoanIdTransactionsTransactionIdRequest

Field Name Required Type Description Format

dateFormat

String

locale

String

note

String

transactionAmount

Double

double

transactionDate

String

.2.895. PostLoansLoanIdTransactionsTransactionIdResponse

PostLoansLoanIdTransactionsTransactionIdResponse

Field Name Required Type Description Format

resourceId

Integer

int32

.2.896. PostLoansRepaymentSchedulePeriods

Field Name Required Type Description Format

dueDate

date

date

feeChargesDue

Long

int64

feeChargesOutstanding

Long

int64

period

Integer

int32

principalDisbursed

Long

int64

principalLoanBalanceOutstanding

Long

int64

totalActualCostOfLoanForPeriod

Long

int64

totalDueForPeriod

Long

int64

totalOriginalDueForPeriod

Long

int64

totalOutstandingForPeriod

Long

int64

totalOverdue

Long

int64

.2.897. PostLoansRequest

PostLoansRequest

Field Name Required Type Description Format

amortizationType

Integer

int32

dateFormat

String

daysInYearType

Integer

int32 Enum: null,

expectedDisbursementDate

String

fixedPrincipalPercentagePerInstallment

BigDecimal

interestCalculationPeriodType

Integer

int32

interestRatePerPeriod

Integer

int32

interestType

Integer

int32

loanTermFrequency

Integer

int32

loanTermFrequencyType

Integer

int32

locale

String

numberOfRepayments

Integer

int32

principal

Double

double

productId

Integer

int32

repaymentEvery

Integer

int32

repaymentFrequencyType

Integer

int32

transactionProcessingStrategyId

Integer

int32

.2.898. PostLoansResponse

PostLoansResponse

Field Name Required Type Description Format

currency

GetLoansLoanIdCurrency

loanTermInDays

Integer

int32

periods

Set of Section .2.896

totalFeeChargesCharged

Long

int64

totalInterestCharged

Double

double

totalOutstanding

Long

int64

totalPenaltyChargesCharged

Long

int64

totalPrincipalDisbursed

Long

int64

totalPrincipalExpected

Long

int64

totalPrincipalPaid

Long

int64

totalRepayment

Long

int64

totalRepaymentExpected

Double

double

totalWaived

Long

int64

totalWrittenOff

Long

int64

.2.899. PostMakerCheckersResponse

PostMakerCheckersResponse

Field Name Required Type Description Format

auditId

Long

int64

.2.900. PostNewShareApplicationResponse

PostNewShareApplicationResponse

Field Name Required Type Description Format

resourceId

Integer

int32

.2.901. PostNewTransferResponse

PostNewTransferResponse

Field Name Required Type Description Format

resourceId

Integer

int32

savingsId

Integer

int32

.2.902. PostOfficesRequest

PostOfficesRequest

Field Name Required Type Description Format

dateFormat

String

externalId

String

locale

String

name

String

openingDate

date

date

parentId

Long

int64

.2.903. PostOfficesResponse

PostOfficesResponse

Field Name Required Type Description Format

officeId

Long

int64

resourceId

Long

int64

.2.904. PostPaymentTypesRequest

PostPaymentTypesRequest

Field Name Required Type Description Format

description

String

isCashPayment

Boolean

name

String

position

Integer

int32

.2.905. PostPaymentTypesResponse

PostPaymentTypesResponse

Field Name Required Type Description Format

resourceId

Integer

int32

.2.906. PostProductsChargesSelected

Field Name Required Type Description Format

id

Integer

int32

.2.907. PostProductsMarketPricePeriods

Field Name Required Type Description Format

dateFormat

String

fromDate

String

locale

String

shareValue

Integer

int32

.2.908. PostProductsTypeRequest

PostProductsTypeRequest

Field Name Required Type Description Format

accountingRule

Integer

int32

allowDividendCalculationForInactiveClients

Boolean

chargesSelected

Set of Section .2.906

currencyCode

String

description

String

digitsAfterDecimal

Integer

int32

inMultiplesOf

Integer

int32

locale

String

lockinPeriodFrequency

Integer

int32

lockinPeriodFrequencyType

Integer

int32

marketPricePeriods

Set of Section .2.907

maximumShares

Integer

int32

minimumActivePeriodForDividends

Integer

int32

minimumShares

Integer

int32

minimumactiveperiodFrequencyType

Integer

int32

name

String

nominalShares

Integer

int32

sharesIssued

Integer

int32

shortName

String

totalShares

Integer

int32

unitPrice

Integer

int32

.2.909. PostProductsTypeResponse

PostProductsTypeResponse

Field Name Required Type Description Format

resourceId

Integer

int32

.2.910. PostProvisioningCriteriaRequest

PostProvisioningCriteriaRequest

Field Name Required Type Description Format

criteriaName

String

loanProducts

List of Section .2.760

provisioningcriteria

List of Section .2.985

.2.911. PostProvisioningCriteriaResponse

PostProvisioningCriteriaResponse

Field Name Required Type Description Format

resourceId

Long

int64

.2.912. PostProvisioningEntriesRequest

PostProvisioningEntriesRequest

Field Name Required Type Description Format

createjournalentries

String

date

String

dateFormat

String

entries

String

locale

String

provisioningentry

String

.2.913. PostProvisioningEntriesResponse

PostProvisioningEntriesResponse

Field Name Required Type Description Format

resourceId

Long

int64

.2.914. PostRecurringChanges

Field Name Required Type Description Format

accountNumber

String

bankNumber

String

checkNumber

String

receiptNumber

String

routingCode

String

.2.915. PostRecurringDepositAccountsAccountIdResponse

PostRecurringDepositAccountsAccountIdResponse

Field Name Required Type Description Format

clientId

Integer

int32

officeId

Integer

int32

resourceId

Integer

int32

savingsId

Integer

int32

.2.916. PostRecurringDepositAccountsRecurringDepositAccountIdTransactionsRequest

PostRecurringDepositAccountsRecurringDepositAccountIdTransactionsRequest

Field Name Required Type Description Format

accountNumber

String

bankNumber

String

checkNumber

String

dateFormat

String

locale

String

paymentTypeId

Integer

int32

receiptNumber

String

routingCode

String

transactionAmount

Double

double

transactionDate

String

.2.917. PostRecurringDepositAccountsRecurringDepositAccountIdTransactionsResponse

PostRecurringDepositAccountsRecurringDepositAccountIdTransactionsResponse

Field Name Required Type Description Format

changes

PostRecurringChanges

clientId

Integer

int32

officeId

Integer

int32

resourceId

Integer

int32

savingsId

Integer

int32

.2.918. PostRecurringDepositAccountsRecurringDepositAccountIdTransactionsTransactionIdResponse

PostRecurringDepositAccountsRecurringDepositAccountIdTransactionsTransactionIdResponse

Field Name Required Type Description Format

changes

PostRecurringChanges

clientId

Integer

int32

officeId

Integer

int32

resourceId

Integer

int32

savingsId

Integer

int32

.2.919. PostRecurringDepositAccountsRequest

PostRecurringDepositAccountsRequest

Field Name Required Type Description Format

clientId

Integer

int32

dateFormat

String

depositAmount

Float

float

depositPeriod

Integer

int32

depositPeriodFrequencyId

Integer

int32

isCalendarInherited

Boolean

locale

String

mandatoryRecommendedDepositAmount

Long

int64

productId

Integer

int32

recurringFrequency

Integer

int32

recurringFrequencyType

Integer

int32

submittedOnDate

String

.2.920. PostRecurringDepositAccountsResponse

PostRecurringDepositAccountsResponse

Field Name Required Type Description Format

clientId

Integer

int32

officeId

Integer

int32

resourceId

Integer

int32

savingsId

Integer

int32

.2.921. PostRecurringDepositProductsChartSlabs

Field Name Required Type Description Format

annualInterestRate

Double

double

description

String

fromPeriod

Integer

int32

periodType

Integer

int32

toPeriod

Integer

int32

.2.922. PostRecurringDepositProductsCharts

Field Name Required Type Description Format

chartSlabs

Set of Section .2.921

dateFormat

String

fromDate

String

locale

String

.2.923. PostRecurringDepositProductsRequest

PostRecurringDepositProductsRequest

Field Name Required Type Description Format

accountingRule

Integer

int32

charts

Set of Section .2.922

currencyCode

String

depositAmount

Long

int64

description

String

digitsAfterDecimal

Integer

int32

inMultiplesOf

Integer

int32

interestCalculationDaysInYearType

Integer

int32

interestCalculationType

Integer

int32

interestCompoundingPeriodType

Integer

int32

interestPostingPeriodType

Integer

int32

locale

String

maxDepositAmount

Long

int64

maxDepositTerm

Integer

int32

maxDepositTermTypeId

Integer

int32

minDepositAmount

Long

int64

minDepositTerm

Integer

int32

minDepositTermTypeId

Integer

int32

name

String

preClosurePenalApplicable

Boolean

preClosurePenalInterest

Double

double

preClosurePenalInterestOnTypeId

Integer

int32

recurringDepositFrequency

Integer

int32

recurringDepositFrequencyTypeId

Integer

int32

shortName

String

.2.924. PostRecurringDepositProductsResponse

PostRecurringDepositProductsResponse

Field Name Required Type Description Format

resourceId

Integer

int32

.2.925. PostReportMailingJobsRequest

PostReportMailingJobsRequest

Field Name Required Type Description Format

dateFormat

String

description

String

emailMessage

String

emailRecipients

String

emailSubject

String

isActive

Boolean

locale

String

name

String

recurrence

String

startDateTime

Date

date-time

stretchyReportId

Long

int64

stretchyReportParamMap

String

.2.926. PostReportMailingJobsResponse

PostReportMailingJobsResponse

Field Name Required Type Description Format

resourceId

Long

int64

.2.927. PostReportsResponse

PostReportsResponse

Field Name Required Type Description Format

resourceId

Long

int64

.2.928. PostRepostRequest

PostRepostRequest

Field Name Required Type Description Format

description

String

reportCategory

String

reportName

String

reportParameters

List of [object]

reportSql

String

reportSubType

String

reportType

String

.2.929. PostResourceTypeResourceIdNotesRequest

PostResourceTypeResourceIdNotesRequest

Field Name Required Type Description Format

note

String

.2.930. PostResourceTypeResourceIdNotesResponse

PostResourceTypeResourceIdNotesResponse

Field Name Required Type Description Format

clientId

Integer

int32

officeId

Integer

int32

resourceId

Integer

int32

.2.931. PostRolesRequest

PostRolesRequest

Field Name Required Type Description Format

description

String

name

String

.2.932. PostRolesResponse

PostRolesResponse

Field Name Required Type Description Format

resourceId

Long

int64

.2.933. PostRolesRoleIdPermissionsResponsePermissions

Field Name Required Type Description Format

ALL_FUNCTIONS_READ

String

.2.934. PostRolesRoleIdResponse

PostRolesRoleIdResponse

Field Name Required Type Description Format

resourceId

Long

int64

.2.935. PostRunaccrualsRequest

runaccrualsRequest

Field Name Required Type Description Format

dateFormat

String

locale

String

tillDate

X

String

which specifies periodic accruals should happen till the given Date

.2.936. PostSavingsAccountTransactionsRequest

PostSavingsAccountTransactionsRequest

Field Name Required Type Description Format

dateFormat

String

lienAllowed

String

locale

String

reasonForBlock

String

transactionAmount

Integer

int32

transactionDate

String

.2.937. PostSavingsAccountTransactionsResponse

PostSavingsAccountTransactionsResponse

Field Name Required Type Description Format

clientId

Integer

int32

officeId

Integer

int32

resourceId

Integer

int32

savingsId

Integer

int32

.2.938. PostSavingsAccountsAccountIdRequest

PostSavingsAccountsAccountIdRequest

Field Name Required Type Description Format

activatedOnDate

String

approvedOnDate

String

dateFormat

String

locale

String

.2.939. PostSavingsAccountsAccountIdResponse

PostSavingsAccountsAccountIdResponse

Field Name Required Type Description Format

changes

Object

clientId

Integer

int32

officeId

Integer

int32

resourceId

Integer

int32

.2.940. PostSavingsAccountsRequest

PostSavingsAccountsRequest

Field Name Required Type Description Format

clientId

Integer

int32

dateFormat

String

locale

String

productId

Integer

int32

submittedOnDate

String

.2.941. PostSavingsAccountsResponse

PostSavingsAccountsResponse

Field Name Required Type Description Format

clientId

Integer

int32

officeId

Integer

int32

resourceId

Integer

int32

savingsId

Integer

int32

.2.942. PostSavingsAccountsSavingsAccountIdChargesRequest

PostSavingsAccountsSavingsAccountIdChargesRequest

Field Name Required Type Description Format

amount

Float

float

chargeId

Integer

int32

dateFormat

String

dueDate

String

locale

String

.2.943. PostSavingsAccountsSavingsAccountIdChargesResponse

PostSavingsAccountsSavingsAccountIdChargesResponse

Field Name Required Type Description Format

clientId

Integer

int32

officeId

Integer

int32

resourceId

Integer

int32

savingsId

Integer

int32

.2.944. PostSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdRequest

PostSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdRequest

Field Name Required Type Description Format

amount

Float

float

dateFormat

String

dueDate

String

locale

String

.2.945. PostSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdResponse

PostSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdResponse

Field Name Required Type Description Format

clientId

Integer

int32

officeId

Integer

int32

resourceId

Integer

int32

savingsId

Integer

int32

.2.946. PostSavingsCharges

Field Name Required Type Description Format

id

Integer

int32

.2.947. PostSavingsProductsRequest

PostSavingsProductsRequest

Field Name Required Type Description Format

accountMappingForPayment

String

accountingRule

Integer

int32

charges

Set of Section .2.946

currencyCode

String

description

String

digitsAfterDecimal

Integer

int32

inMultiplesOf

Integer

int32

interestCalculationDaysInYearType

Integer

int32

interestCalculationType

Integer

int32

interestCompoundingPeriodType

Integer

int32

interestPostingPeriodType

Integer

int32

locale

String

name

String

nominalAnnualInterestRate

Double

double

shortName

String

.2.948. PostSavingsProductsResponse

PostSavingsProductsResponse

Field Name Required Type Description Format

resourceId

Integer

int32

.2.949. PostSelfAuthenticationResponse

PostSelfAuthenticationResponse

Field Name Required Type Description Format

authenticated

Boolean

base64EncodedAuthenticationKey

String

clients

List of [integer]

int32

isSelfServiceUser

Boolean

officeId

Integer

int32

officeName

String

organisationalRole

GetSelfUserDetailsOrganisationalRole

permissions

List of [string]

roles

Set of Section .2.671

staffDisplayName

String

staffId

Integer

int32

userId

Integer

int32

username

String

.2.950. PostSelfBeneficiariesTPTRequest

PostSelfBeneficiariesTPTRequest

Field Name Required Type Description Format

accountNumber

Long

int64

accountType

Integer

int32

locale

String

name

String

officeName

String

transferLimit

Integer

int32

.2.951. PostSelfBeneficiariesTPTResponse

PostSelfBeneficiariesTPTResponse

Field Name Required Type Description Format

resourceId

Integer

int32

.2.952. PostSelfLoansData

Field Name Required Type Description Format

Activation_Date

String

dateFormat

String

locale

String

.2.953. PostSelfLoansDatatables

Field Name Required Type Description Format

data

PostSelfLoansData

registeredTableName

String

.2.954. PostSelfLoansDisbursementData

Field Name Required Type Description Format

approvedPrincipal

Long

int64

expectedDisbursementDate

String

principal

Long

int64

.2.955. PostSelfLoansLoanIdChanges

Field Name Required Type Description Format

closedOnDate

String

dateFormat

String

locale

String

status

PostSelfLoansLoanIdStatus

withdrawnOnDate

String

.2.956. PostSelfLoansLoanIdRequest

PostSelfLoansLoanIdRequest

Field Name Required Type Description Format

dateFormat

String

locale

String

note

String

withdrawnOnDate

String

.2.957. PostSelfLoansLoanIdResponse

PostSelfLoansLoanIdResponse

Field Name Required Type Description Format

changes

PostSelfLoansLoanIdChanges

clientId

Integer

int32

loanId

Integer

int32

officeId

Integer

int32

resourceId

Integer

int32

.2.958. PostSelfLoansLoanIdStatus

Field Name Required Type Description Format

active

Boolean

closed

Boolean

closedObligationsMet

Boolean

closedRescheduled

Boolean

closedWrittenOff

Boolean

code

String

description

String

id

Integer

int32

overpaid

Boolean

pendingApproval

Boolean

waitingForDisbursal

Boolean

.2.959. PostSelfLoansRequest

PostSelfLoansRequest

Field Name Required Type Description Format

amortizationType

Integer

int32

clientId

Integer

int32

datatables

Set of Section .2.953

dateFormat

String

disbursementData

Set of Section .2.954

expectedDisbursementDate

String

fixedEmiAmount

Integer

int32

interestCalculationPeriodType

Integer

int32

interestRatePerPeriod

Integer

int32

interestType

Integer

int32

linkAccountId

Integer

int32

loanTermFrequency

Integer

int32

loanTermFrequencyType

Integer

int32

loanType

String

locale

String

maxOutstandingLoanBalance

Long

int64

numberOfRepayments

Integer

int32

principal

Double

double

productId

Integer

int32

repaymentEvery

Integer

int32

repaymentFrequencyType

Integer

int32

submittedOnDate

String

transactionProcessingStrategyId

Integer

int32

.2.960. PostSelfLoansResponse

PostSelfLoansResponse

Field Name Required Type Description Format

clientId

Integer

int32

loanId

Integer

int32

officeId

Integer

int32

resourceId

Integer

int32

.2.961. PostStaffRequest

PostStaffRequest

Field Name Required Type Description Format

dateFormat

String

externalId

String

firstname

String

isActive

Boolean

isLoanOfficer

Boolean

joiningDate

date

date

lastname

String

locale

String

mobileNo

String

officeId

Long

int64

.2.962. PostStandingInstructionsRequest

PostStandingInstructionsRequest

Field Name Required Type Description Format

amount

Integer

int32

dateFormat

String

fromAccountId

Long

int64

fromAccountType

Integer

int32

fromClientId

Long

int64

fromOfficeId

Long

int64

instructionType

Integer

int32

locale

String

en

monthDayFormat

String

name

String

priority

Integer

int32

recurrenceFrequency

Integer

int32

recurrenceInterval

Integer

int32

recurrenceOnMonthDay

String

recurrenceType

Integer

int32

status

Integer

int32

toAccountId

Long

int64

toAccountType

Integer

int32

toClientId

Long

int64

toOfficeId

Long

int64

transferType

Integer

int32

validFrom

String

.2.963. PostStandingInstructionsResponse

PostStandingInstructionsResponse

Field Name Required Type Description Format

clientId

Long

int64

resourceId

Integer

int32

.2.964. PostSurveySurveyNameApptableIdRequest

PostSurveySurveyNameApptableIdRequest

Field Name Required Type Description Format

Date

Date

date-time

dateFormat

Date

date-time

locale

String

ppi_businessoccupation_cd_q3_businessoccupation

Long

int64

ppi_floortype_cd_q5_floortype

Long

int64

ppi_fryingpans_cd_q10_fryingpans

Long

int64

ppi_habitablerooms_cd_q4_habitablerooms

Long

int64

ppi_highestschool_cd_q2_highestschool

Long

int64

ppi_household_members_cd_q1_householdmembers

Long

int64

ppi_irons_cd_q7_irons

Long

int64

ppi_lightingsource_cd_q6_lightingsource

Long

int64

ppi_mosquitonets_cd_q8_mosquitonets

Long

int64

ppi_towels_cd_q9_towels

Long

int64

.2.965. PostSurveySurveyNameApptableIdResponse

PostSurveySurveyNameApptableIdResponse

Field Name Required Type Description Format

clientId

Long

int64

officeId

Long

int64

resourceId

Long

int64

.2.966. PostTaxesComponentsRequest

PostTaxesComponentsRequest

Field Name Required Type Description Format

creditAccountType

Integer

int32

creditAcountId

Integer

int32

dateFormat

String

locale

String

name

String

percentage

Float

float

startDate

String

.2.967. PostTaxesComponentsResponse

PostTaxesComponentsResponse

Field Name Required Type Description Format

resourceId

Integer

int32

.2.968. PostTaxesGroupRequest

PostTaxesGroupRequest

Field Name Required Type Description Format

dateFormat

String

locale

String

name

String

taxComponents

Set of Section .2.970

.2.969. PostTaxesGroupResponse

PostTaxesGroupResponse

Field Name Required Type Description Format

resourceId

Integer

int32

.2.970. PostTaxesGroupTaxComponents

Field Name Required Type Description Format

startDate

String

taxComponentId

Integer

int32

.2.971. PostTellersRequest

PostTellersRequest

Field Name Required Type Description Format

dateFormat

String

description

String

locale

String

name

String

officeId

Long

int64

startDate

date

date

status

String

Enum: INVALID, PENDING, ACTIVE, INACTIVE, CLOSED,

.2.972. PostTellersResponse

PostTellersResponse

Field Name Required Type Description Format

officeId

Long

int64

resourceId

Long

int64

.2.973. PostTellersTellerIdCashiersCashierIdAllocateRequest

PostTellersTellerIdCashiersCashierIdAllocateRequest

Field Name Required Type Description Format

currencyCode

String

dateFormat

String

locale

String

txnAmount

BigDecimal

txnDate

Date

date-time

txnNote

String

.2.974. PostTellersTellerIdCashiersCashierIdAllocateResponse

PostTellersTellerIdCashiersCashierIdAllocateResponse

Field Name Required Type Description Format

resourceId

Long

int64

subResourceId

Long

int64

.2.975. PostTellersTellerIdCashiersCashierIdSettleRequest

PostTellersTellerIdCashiersCashierIdSettleRequest

Field Name Required Type Description Format

currencyCode

String

dateFormat

String

locale

String

txnAmount

BigDecimal

txnDate

Date

date-time

txnNote

String

.2.976. PostTellersTellerIdCashiersCashierIdSettleResponse

PostTellersTellerIdCashiersCashierIdSettleResponse

Field Name Required Type Description Format

resourceId

Long

int64

subResourceId

Long

int64

.2.977. PostTellersTellerIdCashiersRequest

PostTellersTellerIdCashiersRequest

Field Name Required Type Description Format

dateFormat

String

description

String

endDate

date

date

isFullDay

Boolean

locale

String

staffId

Long

int64

startDate

date

date

.2.978. PostTellersTellerIdCashiersResponse

PostTellersTellerIdCashiersResponse

Field Name Required Type Description Format

resourceId

Long

int64

subResourceId

Long

int64

.2.979. PostTemplatesRequest

PostTemplatesRequest

Field Name Required Type Description Format

entity

Long

int64

id

Long

int64

mappers

List of Section .2.1185

name

String

text

String

type

Long

int64

.2.980. PostTemplatesResponse

PostTemplatesResponse

Field Name Required Type Description Format

resourceId

Long

int64

.2.981. PostUsersRequest

PostUsersRequest

Field Name Required Type Description Format

email

String

firstname

String

isSelfServiceUser

Boolean

lastname

String

officeId

Long

int64

roles

String

sendPasswordToEmail

Boolean

staffId

Long

int64

username

String

.2.982. PostUsersResponse

PostUsersResponse

Field Name Required Type Description Format

officeId

Long

int64

resourceId

Long

int64

.2.983. PostalAddress

Field Name Required Type Description Format

addressLine1

String

addressLine2

String

city

String

country

String

postalCode

String

stateProvince

String

.2.984. ProcessingResultLookup

Field Name Required Type Description Format

id

Long

int64

processingResult

String

.2.985. ProvisioningCriteriaDefinitionData

Field Name Required Type Description Format

categoryId

Long

int64

categoryName

String

expenseAccount

Long

int64

expenseCode

String

id

Long

int64

liabilityAccount

Long

int64

liabilityCode

String

maxAge

Long

int64

minAge

Long

int64

provisioningPercentage

BigDecimal

.2.986. ProvisioningEntryData

Field Name Required Type Description Format

createdDate

Date

date-time

entries

List of Section .2.765

id

Long

int64

.2.987. PutAccountNumberFormatsRequest

PutAccountNumberFormatsRequest

Field Name Required Type Description Format

prefixType

Long

int64

.2.988. PutAccountNumberFormatsResponse

PutAccountNumberFormatsResponse

Field Name Required Type Description Format

changes

PutAccountNumberFormatschangesSwagger

resourceId

Long

int64

.2.989. PutAccountNumberFormatschangesSwagger

Field Name Required Type Description Format

prefixType

Long

int64

.2.990. PutAccountingRulesRequest

PutAccountingRulesRequest

Field Name Required Type Description Format

name

String

.2.991. PutAccountingRulesResponse

PutAccountingRulesResponse

Field Name Required Type Description Format

changes

PutAccountingRulesResponsechangesSwagger

resourceId

Long

int64

.2.992. PutAccountingRulesResponsechangesSwagger

Field Name Required Type Description Format

name

String

.2.993. PutAccountsChanges

Field Name Required Type Description Format

applicationDate

String

dateFormat

String

locale

String

requestedShares

Integer

int32

.2.994. PutAccountsTypeAccountIdRequest

PutAccountsTypeAccountIdRequest

Field Name Required Type Description Format

applicationDate

String

dateFormat

String

locale

String

requestedShares

Integer

int32

.2.995. PutAccountsTypeAccountIdResponse

PutAccountsTypeAccountIdResponse

Field Name Required Type Description Format

changes

PutAccountsChanges

resourceId

Integer

int32

.2.996. PutCachechangesSwagger

Field Name Required Type Description Format

cacheType

Long

int64

.2.997. PutCachesRequest

PutCachesRequest

Field Name Required Type Description Format

cacheType

Long

int64

.2.998. PutCachesResponse

PutCachesResponse

Field Name Required Type Description Format

cacheType

PutCachechangesSwagger

.2.999. PutCentersCenterIdRequest

PutCentersCenterIdRequest

Field Name Required Type Description Format

name

String

.2.1000. PutCentersCenterIdResponse

PutCentersCenterIdResponse

Field Name Required Type Description Format

changes

PutCentersChanges

groupId

Integer

int32

officeId

Integer

int32

resourceId

Integer

int32

.2.1001. PutCentersChanges

Field Name Required Type Description Format

name

String

.2.1002. PutChargeTransactionChangesRequest

PutChargeTransactionChangesRequest

Field Name Required Type Description Format

id

Integer

int32

loanId

Integer

int32

.2.1003. PutChargeTransactionChangesResponse

PutChargeTransactionChangesResponse

Field Name Required Type Description Format

changes

Changes

loanId

Integer

int32

resourceId

Integer

int32

.2.1004. PutChargesChargeIdRequest

PutChargesChargeIdRequest

Field Name Required Type Description Format

name

String

.2.1005. PutChargesChargeIdResponse

PutChargesChargeIdResponse

Field Name Required Type Description Format

changes

PutChargesChargeIdRequest

resourceId

Integer

int32

.2.1006. PutClientClientIdAddressesRequest

PutClientClientIdAddressesRequest

Field Name Required Type Description Format

addressId

Integer

int32

street

String

.2.1007. PutClientClientIdAddressesResponse

PutClientClientIdAddressesResponse

Field Name Required Type Description Format

resourceId

Integer

int32

.2.1008. PutClientCollateralRequest

PutClientCollateralRequest

Field Name Required Type Description Format

locale

String

quantity

BigDecimal

.2.1009. PutClientCollateralResponse

PutClientCollateralResponse

Field Name Required Type Description Format

changes

PutClientCollateralRequest

clientId

Integer

int32

resourceId

Integer

int32

.2.1010. PutClientsClientIdIdentifiersIdentifierIdRequest

PutClientsClientIdIdentifiersIdentifierIdRequest

Field Name Required Type Description Format

description

String

documentKey

String

documentTypeId

Integer

int32

.2.1011. PutClientsClientIdIdentifiersIdentifierIdResponse

PutClientsClientIdIdentifiersIdentifierIdResponse

Field Name Required Type Description Format

changes

PutClientsClientIdIdentifiersIdentifierIdRequest

clientId

Integer

int32

officeId

Integer

int32

resourceId

Integer

int32

.2.1012. PutClientsClientIdRequest

PutClientsClientIdRequest

Field Name Required Type Description Format

externalId

String

.2.1013. PutClientsClientIdResponse

PutClientsClientIdResponse

Field Name Required Type Description Format

changes

PutClientsClientIdRequest

clientId

Integer

int32

officeId

Integer

int32

resourceId

Integer

int32

.2.1014. PutCodeValueDataResponse

PutCodeValueDataResponse

Field Name Required Type Description Format

changes

PutCodeValuechangesSwagger

resourceId

Long

int64

.2.1015. PutCodeValuechangesSwagger

Field Name Required Type Description Format

description

String

name

String

position

Integer

int32

.2.1016. PutCodeValuesDataRequest

PutCodeValuesDataRequest

Field Name Required Type Description Format

description

String

name

String

position

Integer

int32

.2.1017. PutCodesApichangesSwagger

Field Name Required Type Description Format

name

String

.2.1018. PutCodesRequest

PutCodesRequest

Field Name Required Type Description Format

name

String

.2.1019. PutCodesResponse

PutCodesResponse

Field Name Required Type Description Format

changes

PutCodesApichangesSwagger

resourceId

Long

int64

.2.1020. PutCollateralProductRequest

PutCollateralProductRequest

Field Name Required Type Description Format

basePrice

BigDecimal

currency

String

name

String

pctToBase

BigDecimal

quality

String

unitType

String

.2.1021. PutCollateralProductResponse

PutCollateralProductResponse

Field Name Required Type Description Format

changes

PutCollateralProductRequest

resourceId

Integer

int32

.2.1022. PutCurrenciesRequest

PutCurrenciesRequest

Field Name Required Type Description Format

currencies

String

.2.1023. PutCurrenciesResponse

PutCurrenciesResponse

Field Name Required Type Description Format

currencies

String

.2.1024. PutDataTablesAppTableIdDatatableIdRequest

PutDataTablesAppTableIdDatatableIdRequest

Field Name Required Type Description Format

DateOfBirth

String

Education_cdHighest

Long

int64

Name

String

OtherNotes

String

PointsScore

Long

int64

dateFormat

String

locale

String

.2.1025. PutDataTablesAppTableIdDatatableIdResponse

PutDataTablesAppTableIdDatatableIdResponse

Field Name Required Type Description Format

resourceId

Long

int64

.2.1026. PutDataTablesAppTableIdRequest

PutDataTablesAppTableIdRequest

Field Name Required Type Description Format

BusinessDescription

String

.2.1027. PutDataTablesAppTableIdResponse

PutDataTablesAppTableIdResponse

Field Name Required Type Description Format

changes

PutDataTablesAppTableIdResponseChanges

resourceId

Long

int64

.2.1028. PutDataTablesAppTableIdResponseChanges

Field Name Required Type Description Format

BusinessDescription

String

.2.1029. PutDataTablesRequest

PutDataTablesRequest

Field Name Required Type Description Format

ChangeColumns

List of Section .2.1031

addColumns

List of Section .2.1030

appTableName

String

dropColumns

List of Section .2.1032

.2.1030. PutDataTablesRequestAddColumns

Field Name Required Type Description Format

code

String

mandatory

Boolean

name

String

type

String

.2.1031. PutDataTablesRequestChangeColumns

Field Name Required Type Description Format

code

String

mandatory

Boolean

name

String

newCode

String

newName

String

.2.1032. PutDataTablesRequestDropColumns

Field Name Required Type Description Format

name

String

.2.1033. PutDataTablesResponse

PutDataTablesResponse

Field Name Required Type Description Format

resourceIdentifier

String

.2.1034. PutEntityTypeEntityIdDocumentsResponse

PutEntityTypeEntityIdDocumentsResponse

Field Name Required Type Description Format

changes

Object

resourceId

Long

int64

resourceIdentifier

String

.2.1035. PutExternalServiceRequest

PutExternalServiceRequest

Field Name Required Type Description Format

password

String

username

String

.2.1036. PutFinancialActivityAccountsResponse

PutFinancialActivityAccountsResponse

Field Name Required Type Description Format

comments

PutFinancialActivityAccountscommentsSwagger

resourceId

Long

int64

.2.1037. PutFinancialActivityAccountscommentsSwagger

Field Name Required Type Description Format

glAccountId

Long

int64

.2.1038. PutFixedDepositAccountsAccountIdRequest

PutFixedDepositAccountsAccountIdRequest

Field Name Required Type Description Format

depositAmount

Float

float

locale

String

.2.1039. PutFixedDepositAccountsAccountIdResponse

PutFixedDepositAccountsAccountIdResponse

Field Name Required Type Description Format

changes

PutFixedDepositAccountsChanges

clientId

Integer

int32

officeId

Integer

int32

resourceId

Integer

int32

savingsId

Integer

int32

.2.1040. PutFixedDepositAccountsChanges

Field Name Required Type Description Format

depositAmount

Float

float

locale

String

.2.1041. PutFixedDepositProductsChanges

Field Name Required Type Description Format

description

String

minDepositTerm

Integer

int32

.2.1042. PutFixedDepositProductsProductIdRequest

PutFixedDepositProductsProductIdRequest

Field Name Required Type Description Format

description

String

locale

String

minDepositTerm

Integer

int32

minDepositTermTypeId

Integer

int32

.2.1043. PutFixedDepositProductsProductIdResponse

PutFixedDepositProductsProductIdResponse

Field Name Required Type Description Format

changes

PutFixedDepositProductsChanges

resourceId

Integer

int32

.2.1044. PutFloatingRatesChanges

Field Name Required Type Description Format

ratePeriods

Set of Section .2.850

.2.1045. PutFloatingRatesFloatingRateIdRequest

PutFloatingRatesFloatingRateIdRequest

Field Name Required Type Description Format

isActive

Boolean

isBaseLendingRate

Boolean

name

String

ratePeriods

Set of Section .2.850

.2.1046. PutFloatingRatesFloatingRateIdResponse

PutFloatingRatesFloatingRateIdResponse

Field Name Required Type Description Format

changes

PutFloatingRatesChanges

resourceId

Integer

int32

.2.1047. PutFundsFundIdRequest

PutFundsFundIdRequest

Field Name Required Type Description Format

name

String

.2.1048. PutFundsFundIdResponse

PutFundsFundIdResponse

Field Name Required Type Description Format

changes

PutFundsFundIdRequest

resourceId

Integer

int32

.2.1049. PutGLAccountsRequest

PutGLAccountsRequest

Field Name Required Type Description Format

name

String

.2.1050. PutGLAccountsResponse

PutGLAccountsResponse

Field Name Required Type Description Format

changes

PutGLAccountsResponsechangesSwagger

resourceId

Integer

int32

.2.1051. PutGLAccountsResponsechangesSwagger

Field Name Required Type Description Format

name

String

.2.1052. PutGlClosuresRequest

PutGlClosuresRequest

Field Name Required Type Description Format

comments

String

.2.1053. PutGlClosuresResponse

PutGlClosuresResponse

Field Name Required Type Description Format

comments

String

officeId

Long

int64

resourceId

Long

int64

.2.1054. PutGlobalConfigurationsRequest

PutGlobalConfigurationsRequest

Field Name Required Type Description Format

description

Long

int64

enabled

Boolean

.2.1055. PutGlobalConfigurationsResponse

PutGlobalConfigurationsResponse

Field Name Required Type Description Format

changes

PutGlobalConfigurationsResponsechangesSwagger

resourceId

Long

int64

.2.1056. PutGlobalConfigurationsResponsechangesSwagger

Field Name Required Type Description Format

enabled

Boolean

.2.1057. PutGroupsGroupIdChanges

Field Name Required Type Description Format

name

String

.2.1058. PutGroupsGroupIdRequest

PutGroupsGroupIdRequest

Field Name Required Type Description Format

name

String

.2.1059. PutGroupsGroupIdResponse

PutGroupsGroupIdResponse

Field Name Required Type Description Format

changes

PutGroupsGroupIdChanges

groupId

Integer

int32

officeId

Integer

int32

resourceId

Integer

int32

.2.1060. PutHolidaysHolidayIdRequest

PutHolidaysHolidayIdRequest

Field Name Required Type Description Format

description

String

name

String

.2.1061. PutHolidaysHolidayIdResponse

PutHolidaysHolidayIdResponse

Field Name Required Type Description Format

changes

PutHolidaysHolidayIdResponseChanges

resourceId

Long

int64

.2.1062. PutHolidaysHolidayIdResponseChanges

Field Name Required Type Description Format

description

String

name

String

.2.1063. PutHookRequest

PutHookRequest

Field Name Required Type Description Format

config

List of Section .2.76

displayName

String

events

List of Section .2.73

isActive

Boolean

name

String

templateId

Long

int64

.2.1064. PutHookResponse

PutHookResponse

Field Name Required Type Description Format

changes

PutHookResponseChangesSwagger

resourceId

Long

int64

.2.1065. PutHookResponseChangesSwagger

Field Name Required Type Description Format

config

List of Section .2.76

displayName

String

events

List of Section .2.73

.2.1066. PutInterestRateChartsChartIdChartSlabsChartSlabIdRequest

PutInterestRateChartsChartIdChartSlabsChartSlabIdRequest

Field Name Required Type Description Format

annualInterestRate

Double

double

description

String

.2.1067. PutInterestRateChartsChartIdChartSlabsChartSlabIdResponse

PutInterestRateChartsChartIdChartSlabsChartSlabIdResponse

Field Name Required Type Description Format

changes

PutInterestRateChartsChartIdChartSlabsChartSlabIdRequest

resourceId

Integer

int32

.2.1068. PutInterestRateChartsChartIdRequest

PutInterestRateChartsChartIdRequest

Field Name Required Type Description Format

description

String

name

String

.2.1069. PutInterestRateChartsChartIdResponse

PutInterestRateChartsChartIdResponse

Field Name Required Type Description Format

resourceId

Integer

int32

.2.1070. PutJobsJobIDRequest

PutJobsJobsIDRequest

Field Name Required Type Description Format

active

Boolean

cronExpression

String

displayName

String

.2.1071. PutLoanChanges

Field Name Required Type Description Format

locale

String

principal

Double

double

.2.1072. PutLoanProductsProductIdRequest

PutLoanProductsProductIdRequest

Field Name Required Type Description Format

locale

String

principal

Double

double

.2.1073. PutLoanProductsProductIdResponse

PutLoanProductsProductIdResponse

Field Name Required Type Description Format

changes

PutLoanChanges

resourceId

Integer

int32

.2.1074. PutLoansLoanIdChanges

Field Name Required Type Description Format

locale

String

principal

Long

int64

.2.1075. PutLoansLoanIdChargesChargeIdRequest

PutLoansLoanIdChargesChargeIdRequest
Field Name Required Type Description Format

amount

Float

float

dateFormat

String

dueDate

String

locale

String

.2.1076. PutLoansLoanIdChargesChargeIdResponse

PutLoansLoanIdChargesChargeIdResponse

Field Name Required Type Description Format

changes

PutLoansLoanIdChargesChargeIdRequest

clientId

Long

int64

loanId

Long

int64

officeId

Long

int64

resourceId

Integer

int32

.2.1077. PutLoansLoanIdCollateralsCollateralIdResponse

PutLoansLoanIdCollateralsCollateralIdResponse

Field Name Required Type Description Format

changes

PutLoansLoandIdCollateralsCollateralIdRequest

loanId

Integer

int32

resourceId

Integer

int32

.2.1078. PutLoansLoanIdRequest

PutLoansLoanIdRequest

Field Name Required Type Description Format

amortizationType

Integer

int32

dateFormat

String

expectedDisbursementDate

String

fixedPrincipalPercentagePerInstallment

BigDecimal

interestCalculationPeriodType

Integer

int32

interestRatePerPeriod

Integer

int32

interestType

Integer

int32

loanTermFrequency

Integer

int32

loanTermFrequencyType

Integer

int32

locale

String

numberOfRepayments

Integer

int32

principal

Long

int64

productId

Integer

int32

repaymentEvery

Integer

int32

repaymentFrequencyType

Integer

int32

transactionProcessingStrategyId

Integer

int32

.2.1079. PutLoansLoanIdResponse

PutLoansLoanIdResponse

Field Name Required Type Description Format

changes

PutLoansLoanIdChanges

clientId

Integer

int32

loanId

Integer

int32

officeId

Integer

int32

resourceId

Integer

int32

.2.1080. PutLoansLoandIdCollateralsCollateralIdRequest

PutLoansLoandIdCollateralsCollateralIdRequest

Field Name Required Type Description Format

description

String

.2.1081. PutNotesChanges

Field Name Required Type Description Format

note

String

.2.1082. PutOfficesOfficeIdRequest

PutOfficesOfficeIdRequest

Field Name Required Type Description Format

name

String

.2.1083. PutOfficesOfficeIdResponse

PutOfficesOfficeIdResponse

Field Name Required Type Description Format

changes

PutOfficesOfficeIdResponseChanges

officeId

Long

int64

resourceId

Long

int64

.2.1084. PutOfficesOfficeIdResponseChanges

Field Name Required Type Description Format

name

String

.2.1085. PutPasswordPreferencesTemplateRequest

PutPasswordPreferencesTemplateRequest

Field Name Required Type Description Format

validationPolicyId

Long

int64

.2.1086. PutPaymentTypesPaymentTypeIdRequest

PutPaymentTypesPaymentTypeIdRequest

Field Name Required Type Description Format

description

String

isCashPayment

Boolean

name

String

position

Integer

int32

.2.1087. PutPaymentTypesPaymentTypeIdResponse

PutPaymentTypesPaymentTypeIdResponse

Field Name Required Type Description Format

resourceId

Integer

int32

.2.1088. PutPermissionsRequest

PutPermissionsRequest

Field Name Required Type Description Format

permissions

String

.2.1089. PutProductsChanges

Field Name Required Type Description Format

description

String

locale

String

unitPrice

Double

double

.2.1090. PutProductsTypeProductIdRequest

PutProductsTypeProductIdRequest

Field Name Required Type Description Format

description

String

locale

String

unitPrice

Double

double

.2.1091. PutProductsTypeProductIdResponse

PutProductsTypeProductIdResponse

Field Name Required Type Description Format

changes

PutProductsChanges

resourceId

Integer

int32

.2.1092. PutProvisioningCriteriaRequest

PutProvisioningCriteriaRequest

Field Name Required Type Description Format

criteriaName

String

loanProducts

List of Section .2.760

provisioningcriteria

List of Section .2.985

.2.1093. PutProvisioningCriteriaResponse

PutProvisioningCriteriaResponse

Field Name Required Type Description Format

changes

PutProvisioningCriteriaResponseChanges

resourceId

Long

int64

.2.1094. PutProvisioningCriteriaResponseChanges

Field Name Required Type Description Format

criteriaName

String

.2.1095. PutProvisioningEntriesRequest

PutProvisioningEntriesRequest

Field Name Required Type Description Format

command

String

.2.1096. PutProvisioningEntriesResponse

PutProvisioningEntriesResponse

Field Name Required Type Description Format

resourceId

Long

int64

.2.1097. PutRecurringDepositAccountsAccountIdRequest

PutRecurringDepositAccountsAccountIdRequest

Field Name Required Type Description Format

depositAmount

Integer

int32

locale

String

.2.1098. PutRecurringDepositAccountsAccountIdResponse

PutRecurringDepositAccountsAccountIdResponse

Field Name Required Type Description Format

changes

PutRecurringDepositAccountsChanges

clientId

Integer

int32

officeId

Integer

int32

resourceId

Integer

int32

savingsId

Integer

int32

.2.1099. PutRecurringDepositAccountsChanges

Field Name Required Type Description Format

depositAmount

Integer

int32

locale

String

.2.1100. PutRecurringDepositProductsChanges

Field Name Required Type Description Format

description

String

minDepositTerm

Integer

int32

.2.1101. PutRecurringDepositProductsRequest

PutRecurringDepositProductsRequest

Field Name Required Type Description Format

description

String

locale

String

minDepositTerm

Integer

int32

minDepositTermTypeId

Integer

int32

.2.1102. PutRecurringDepositProductsResponse

PutRecurringDepositProductsResponse

Field Name Required Type Description Format

changes

PutRecurringDepositProductsChanges

resourceId

Integer

int32

.2.1103. PutReportMailingJobsRequest

PutReportMailingJobsRequest

Field Name Required Type Description Format

dateFormat

String

locale

String

startDateTime

Date

date-time

.2.1104. PutReportMailingJobsResponse

PutReportMailingJobsResponse

Field Name Required Type Description Format

changes

PutReportMailingJobsResponseChanges

resourceId

Long

int64

.2.1105. PutReportMailingJobsResponseChanges

Field Name Required Type Description Format

startDateTime

Date

date-time

.2.1106. PutReportRequest

PutReportRequest

Field Name Required Type Description Format

reportName

String

reportParameters

List of [object]

.2.1107. PutReportResponse

PutReportResponse

Field Name Required Type Description Format

changes

PutReportResponseChanges

resourceId

Long

int64

.2.1108. PutReportResponseChanges

Field Name Required Type Description Format

reportName

String

reportParameters

List of [object]

.2.1109. PutResourceTypeResourceIdNotesNoteIdRequest

PutResourceTypeResourceIdNotesNoteIdRequest

Field Name Required Type Description Format

note

String

.2.1110. PutResourceTypeResourceIdNotesNoteIdResponse

PutResourceTypeResourceIdNotesNoteIdResponse

Field Name Required Type Description Format

changes

PutNotesChanges

clientId

Integer

int32

officeId

Integer

int32

resourceId

Integer

int32

.2.1111. PutRolesRoleIdPermissionsRequest

PutRolesRoleIdPermissionsRequest

Field Name Required Type Description Format

permissions

PostRolesRoleIdPermissionsResponsePermissions

.2.1112. PutRolesRoleIdPermissionsResponse

PutRolesRoleIdPermissionsResponse

Field Name Required Type Description Format

permissions

PostRolesRoleIdPermissionsResponsePermissions

resourceId

Long

int64

.2.1113. PutRolesRoleIdRequest

PutRolesRoleIdRequest

Field Name Required Type Description Format

description

String

.2.1114. PutRolesRoleIdResponse

PutRolesRoleIdResponse

Field Name Required Type Description Format

changes

PutRolesRoleIdResponseChanges

resourceId

Long

int64

.2.1115. PutRolesRoleIdResponseChanges

Field Name Required Type Description Format

description

String

.2.1116. PutSavingsAccountsAccountIdRequest

PutSavingsAccountsAccountIdRequest

Field Name Required Type Description Format

locale

String

nominalAnnualInterestRate

Double

double

.2.1117. PutSavingsAccountsAccountIdResponse

PutSavingsAccountsAccountIdResponse

Field Name Required Type Description Format

changes

PutSavingsAccountsChanges

clientId

Integer

int32

officeId

Integer

int32

resourceId

Integer

int32

savingsId

Integer

int32

.2.1118. PutSavingsAccountsChanges

Field Name Required Type Description Format

locale

String

nominalAnnualInterestRate

Double

double

.2.1119. PutSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdRequest

PutSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdRequest

Field Name Required Type Description Format

amount

Float

float

dateFormat

String

dueDate

String

locale

String

.2.1120. PutSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdResponse

PutSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdResponse

Field Name Required Type Description Format

changes

PutSavingsChanges

clientId

Integer

int32

officeId

Integer

int32

resourceId

Integer

int32

savingsId

Integer

int32

.2.1121. PutSavingsChanges

Field Name Required Type Description Format

description

String

interestRate

Double

double

locale

String

.2.1122. PutSavingsProductsProductIdRequest

PutSavingsProductsProductIdRequest

Field Name Required Type Description Format

description

String

interestRate

Double

double

locale

String

.2.1123. PutSavingsProductsProductIdResponse

PutSavingsProductsProductIdResponse

Field Name Required Type Description Format

changes

PutSavingsChanges

resourceId

Integer

int32

.2.1124. PutSelfBeneficiariesChanges

Field Name Required Type Description Format

name

String

transferLimit

Integer

int32

.2.1125. PutSelfBeneficiariesTPTBeneficiaryIdRequest

PutSelfBeneficiariesTPTBeneficiaryIdRequest

Field Name Required Type Description Format

name

String

transferLimit

Integer

int32

.2.1126. PutSelfBeneficiariesTPTBeneficiaryIdResponse

PutSelfBeneficiariesTPTBeneficiaryIdResponse

Field Name Required Type Description Format

changes

PutSelfBeneficiariesChanges

resourceId

Integer

int32

.2.1127. PutSelfLoansChanges

Field Name Required Type Description Format

locale

String

principal

Long

int64

.2.1128. PutSelfLoansLoanIdRequest

PutSelfLoansLoanIdRequest

Field Name Required Type Description Format

amortizationType

Integer

int32

dateFormat

String

expectedDisbursementDate

String

interestCalculationPeriodType

Integer

int32

interestRatePerPeriod

Integer

int32

interestType

Integer

int32

loanTermFrequency

Integer

int32

loanTermFrequencyType

Integer

int32

locale

String

numberOfRepayments

Integer

int32

principal

Long

int64

productId

Integer

int32

repaymentEvery

Integer

int32

repaymentFrequencyType

Integer

int32

transactionProcessingStrategyId

Integer

int32

.2.1129. PutSelfLoansLoanIdResponse

PutSelfLoansLoanIdResponse

Field Name Required Type Description Format

changes

PutSelfLoansChanges

clientId

Integer

int32

loanId

Integer

int32

officeId

Integer

int32

resourceId

Integer

int32

.2.1130. PutSelfUserChanges

Field Name Required Type Description Format

passwordEncoded

String

.2.1131. PutSelfUserRequest

PutSelfUserRequest

Field Name Required Type Description Format

password

String

repeatPassword

String

.2.1132. PutSelfUserResponse

PutSelfUserResponse

Field Name Required Type Description Format

changes

PutSelfUserChanges

officeId

Integer

int32

resourceId

Integer

int32

.2.1133. PutStaffRequest

PutStaffRequest

Field Name Required Type Description Format

externalId

String

isLoanOfficer

Boolean

.2.1134. PutStandingInstructionsStandingInstructionIdRequest

PutStandingInstructionsStandingInstructionIdRequest

Field Name Required Type Description Format

recurrenceInterval

Integer

int32

.2.1135. PutStandingInstructionsStandingInstructionIdResponse

PutStandingInstructionsStandingInstructionIdResponse

Field Name Required Type Description Format

changes

PutUpdateStandingInstructionChanges

resourceId

Integer

int32

.2.1136. PutTaxesComponentsChanges

Field Name Required Type Description Format

name

String

percentage

Float

float

startDate

date

date

.2.1137. PutTaxesComponentsTaxComponentIdRequest

PutTaxesComponentsTaxComponentIdRequest

Field Name Required Type Description Format

dateFormat

String

locale

String

name

String

percentage

Float

float

startDate

String

.2.1138. PutTaxesComponentsTaxComponentIdResponse

PutTaxesComponentsTaxComponentIdResponse

Field Name Required Type Description Format

changes

PutTaxesComponentsChanges

resourceId

Integer

int32

.2.1139. PutTaxesGroupChanges

Field Name Required Type Description Format

addComponents

List of [integer]

int32

modifiedComponents

Set of Section .2.1140

name

String

.2.1140. PutTaxesGroupModifiedComponents

Field Name Required Type Description Format

endDate

String

taxComponentId

Integer

int32

.2.1141. PutTaxesGroupTaxComponents

Field Name Required Type Description Format

endDate

String

id

Integer

int32

taxComponentId

Integer

int32

.2.1142. PutTaxesGroupTaxGroupIdRequest

PutTaxesGroupTaxGroupIdRequest

Field Name Required Type Description Format

dateFormat

String

locale

String

name

String

taxComponents

Set of Section .2.1141

.2.1143. PutTaxesGroupTaxGroupIdResponse

PutTaxesGroupTaxGroupIdResponse

Field Name Required Type Description Format

changes

PutTaxesGroupChanges

resourceId

Integer

int32

.2.1144. PutTellersRequest

PutTellersRequest

Field Name Required Type Description Format

dateFormat

String

description

String

endDate

date

date

locale

String

name

String

officeId

Long

int64

startDate

date

date

status

String

Enum: INVALID, PENDING, ACTIVE, INACTIVE, CLOSED,

.2.1145. PutTellersResponse

PutTellersResponse

Field Name Required Type Description Format

changes

PutTellersResponseChanges

officeId

Long

int64

resourceId

Long

int64

.2.1146. PutTellersResponseChanges

Field Name Required Type Description Format

dateFormat

String

description

String

endDate

date

date

locale

String

startDate

date

date

.2.1147. PutTellersTellerIdCashiersCashierIdRequest

PutTellersTellerIdCashiersCashierIdRequest

Field Name Required Type Description Format

dateFormat

String

description

String

endDate

date

date

isFullDay

Boolean

locale

String

staffId

Long

int64

startDate

date

date

.2.1148. PutTellersTellerIdCashiersCashierIdResponse

PutTellersTellerIdCashiersCashierIdResponse

Field Name Required Type Description Format

changes

PutTellersTellerIdCashiersCashierIdResponseChanges

resourceId

Long

int64

subResourceId

Long

int64

.2.1149. PutTellersTellerIdCashiersCashierIdResponseChanges

Field Name Required Type Description Format

dateFormat

String

description

String

endDate

date

date

locale

String

.2.1150. PutTemplatesTemplateIdRequest

PutTemplatesTemplateIdRequest

Field Name Required Type Description Format

entity

Long

int64

id

Long

int64

mappers

List of Section .2.1185

name

String

text

String

type

Long

int64

.2.1151. PutTemplatesTemplateIdResponse

PutTemplatesTemplateIdResponse

Field Name Required Type Description Format

resourceId

Long

int64

.2.1152. PutUpdateStandingInstructionChanges

Field Name Required Type Description Format

recurrenceInterval

Integer

int32

.2.1153. PutUsersUserIdRequest

PutUsersUserIdRequest

Field Name Required Type Description Format

firstname

String

password

String

repeatPassword

String

.2.1154. PutUsersUserIdResponse

PutUsersUserIdResponse

Field Name Required Type Description Format

changes

PutUsersUserIdResponseChanges

officeId

Long

int64

resourceId

Long

int64

.2.1155. PutUsersUserIdResponseChanges

Field Name Required Type Description Format

firstname

String

passwordEncoded

String

.2.1156. PutWorkingDaysRequest

PutWorkingDaysRequest

Field Name Required Type Description Format

extendTermForDailyRepayments

Boolean

locale

String

recurrence

String

repaymentRescheduleType

EnumOptionData

.2.1157. PutWorkingDaysResponse

PutWorkingDaysResponse

Field Name Required Type Description Format

resourceId

Long

int64

.2.1158. Question

Field Name Required Type Description Format

componentKey

String

description

String

id

Long

int64

key

String

new

Boolean

responses

List of Section .2.1162

sequenceNo

Integer

int32

survey

Survey

text

String

.2.1159. QuestionData

Field Name Required Type Description Format

componentKey

String

description

String

id

Long

int64

key

String

responseDatas

List of Section .2.1163

sequenceNo

Integer

int32

text

String

.2.1160. Rate

Field Name Required Type Description Format

active

Boolean

approveUser

AppUser

createdBy

AppUser

createdDate

Date

date-time

id

Long

int64

lastModifiedBy

AppUser

lastModifiedDate

Date

date-time

name

String

new

Boolean

percentage

BigDecimal

productApply

Integer

int32

.2.1161. ReportMailingJobRunHistoryData

Field Name Required Type Description Format

endDateTime

Date

date-time

errorLog

String

errorMessage

String

id

Long

int64

reportMailingJobId

Long

int64

startDateTime

Date

date-time

status

String

.2.1162. Response

Field Name Required Type Description Format

id

Long

int64

new

Boolean

question

Question

sequenceNo

Integer

int32

text

String

value

Integer

int32

.2.1163. ResponseData

Field Name Required Type Description Format

id

Long

int64

sequenceNo

Integer

int32

text

String

value

Integer

int32

.2.1164. ResultsetColumnHeaderData

Field Name Required Type Description Format

booleanDisplayType

Boolean

codeLookupDisplayType

Boolean

codeValueDisplayType

Boolean

columnCode

String

columnDisplayType

String

columnLength

Long

int64

columnName

String

columnType

String

dateDisplayType

Boolean

dateTimeDisplayType

Boolean

decimalDisplayType

Boolean

integerDisplayType

Boolean

isColumnNullable

Boolean

isColumnPrimaryKey

Boolean

mandatory

Boolean

optional

Boolean

string

Boolean

.2.1165. ResultsetRowData

Field Name Required Type Description Format

row

List of [string]

.2.1166. RetrieveOneResponse

GetStaffResponse

Field Name Required Type Description Format

displayName

String

externalId

String

firstname

String

id

Long

int64

isActive

Boolean

isLoanOfficer

Boolean

joiningDate

date

date

lastname

String

officeId

Long

int64

officeName

String

.2.1167. Role

Field Name Required Type Description Format

disabled

Boolean

enabled

Boolean

id

Long

int64

name

String

new

Boolean

permissions

List of Section .2.780

.2.1168. RoleData

Field Name Required Type Description Format

id

Long

int64

name

String

.2.1169. RunReportsResponse

Field Name Required Type Description Format

columnHeaders

List of Section .2.1164

data

List of Section .2.1165

.2.1170. SavingsProductData

Field Name Required Type Description Format

accrualBasedAccountingEnabled

Boolean

allowOverdraft

Boolean

cashBasedAccountingEnabled

Boolean

currency

CurrencyData

depositAccountType

String

id

Long

int64

interestCalculationDaysInYearType

EnumOptionData

interestCalculationType

EnumOptionData

interestCompoundingPeriodType

EnumOptionData

interestPostingPeriodType

EnumOptionData

lockinPeriodFrequency

Integer

int32

lockinPeriodFrequencyType

EnumOptionData

maxAllowedLienLimit

BigDecimal

minRequiredBalance

BigDecimal

minRequiredOpeningBalance

BigDecimal

name

String

nominalAnnualInterestRate

BigDecimal

overdraftLimit

BigDecimal

periodicAccrualAccounting

Boolean

upfrontAccrualAccounting

Boolean

withdrawalFeeForTransfers

Boolean

.2.1171. Scorecard

Field Name Required Type Description Format

appUser

AppUser

client

Client

createdOn

Date

date-time

id

Long

int64

new

Boolean

question

Question

response

Response

survey

Survey

value

Integer

int32

.2.1172. ScorecardData

Field Name Required Type Description Format

clientId

Long

int64

id

Long

int64

scorecardValues

List of Section .2.1173

surveyId

Long

int64

surveyName

String

userId

Long

int64

username

String

.2.1173. ScorecardValue

Field Name Required Type Description Format

createdOn

Date

date-time

questionId

Long

int64

responseId

Long

int64

value

Integer

int32

.2.1174. SingleDebitOrCreditEntryCommand

Field Name Required Type Description Format

amount

BigDecimal

comments

String

commentsChanged

Boolean

glAccountId

Long

int64

glAccountIdChanged

Boolean

glAmountChanged

Boolean

parametersPassedInRequest

Set of [string]

.2.1175. SmsCampaignData

Field Name Required Type Description Format

campaignName

String

campaignStatus

EnumOptionData

campaignType

EnumOptionData

id

Long

int64

lastTriggerDate

date

date

message

String

nextTriggerDate

Date

date-time

notification

Boolean

paramValue

String

recurrence

String

recurrenceStartDate

Date

date-time

reportName

String

runReportId

Long

int64

.2.1176. Staff

Field Name Required Type Description Format

active

Boolean

id

Long

int64

image

Image

loanOfficer

Boolean

new

Boolean

notActive

Boolean

notLoanOfficer

Boolean

.2.1177. StaffData

Field Name Required Type Description Format

displayName

String

firstname

String

id

Long

int64

joiningDate

date

date

lastname

String

officeId

Long

int64

officeName

String

rowIndex

Integer

int32

.2.1178. SubjectName

Field Name Required Type Description Format

displayName

String

firstName

String

lastName

String

middleName

String

.2.1179. Survey

Field Name Required Type Description Format

components

List of Section .2.21

countryCode

String

description

String

id

Long

int64

key

String

name

String

new

Boolean

questions

List of Section .2.1158

validFrom

Date

date-time

validTo

Date

date-time

.2.1180. SurveyData

Field Name Required Type Description Format

componentDatas

List of Section .2.22

countryCode

String

description

String

id

Long

int64

key

String

name

String

questionDatas

List of Section .2.1159

validFrom

Date

date-time

validTo

Date

date-time

.2.1181. TaxComponent

Field Name Required Type Description Format

createdBy

AppUser

createdDate

Date

date-time

creditAccountType

Integer

int32

creditAcount

GLAccount

debitAccountType

Integer

int32

debitAcount

GLAccount

id

Long

int64

lastModifiedBy

AppUser

lastModifiedDate

Date

date-time

new

Boolean

percentage

BigDecimal

taxComponentHistories

Set of Section .2.1182

taxGroupMappings

Set of Section .2.1184

.2.1182. TaxComponentHistory

Field Name Required Type Description Format

createdBy

AppUser

createdDate

Date

date-time

id

Long

int64

lastModifiedBy

AppUser

lastModifiedDate

Date

date-time

new

Boolean

percentage

BigDecimal

.2.1183. TaxGroup

Field Name Required Type Description Format

createdBy

AppUser

createdDate

Date

date-time

id

Long

int64

lastModifiedBy

AppUser

lastModifiedDate

Date

date-time

name

String

new

Boolean

taxGroupMappings

Set of Section .2.1184

.2.1184. TaxGroupMappings

Field Name Required Type Description Format

createdBy

AppUser

createdDate

Date

date-time

endDate

Date

date-time

id

Long

int64

lastModifiedBy

AppUser

lastModifiedDate

Date

date-time

new

Boolean

taxComponent

TaxComponent

taxGroup

TaxGroup

.2.1185. TemplateMapper

Field Name Required Type Description Format

id

Long

int64

mapperkey

String

mapperorder

Integer

int32

mappervalue

String

new

Boolean

.2.1186. UpdateChangesResponse

Field Name Required Type Description Format

accountNo

Long

int64

amount

BigDecimal

bankName

String

date

date

date

.2.1187. UpdatePostDatedCheckRequest

UpdatePostDatedCheckRequest

Field Name Required Type Description Format

accountNo

Long

int64

amount

BigDecimal

date

date

date

dateFormat

String

locale

String

name

String

repaymentDate

date

date

.2.1188. UpdatePostDatedCheckResponse

UpdatePostDatedCheckResponse

Field Name Required Type Description Format

changes

UpdateChangesResponse

resourceId

Integer

int32

.2.1189. UpdateStaffResponse

PutStaffResponse

Field Name Required Type Description Format

officeId

Long

int64

resourceId

Long

int64

1. Fineract SDKs

TBD

1.1. Generate Apache Fineract API Client

Apache Fineract supports client code generation using OpenAPI Generator. It uses OpenAPI Specification Version 3.0.3.

1.1.1. Fineract SDK Java API Client

The fineract-client.jar will eventually be available on Maven Central (watch FINERACT-1102). Until it is, you can quite easily build the latest and greatest version locally from source, see below.

The FineractClient is the entry point to the Fineract SDK Java API Client. Calls is a convenient and recommended utility to simplify the use of the retrofit2.Call type which all API operations return. This permits you to use the API like the FineractClientDemo illustrates:

import org.apache.fineract.client.util.FineractClient;
import static org.apache.fineract.client.util.Calls.ok;

        FineractClient fineract = FineractClient.builder().baseURL("https://demo.fineract.dev/fineract-provider/api/v1/").tenant("default")
                .basicAuth("mifos", "password").build();
        List<RetrieveOneResponse> staff = Calls.ok(fineract.staff.retrieveAll16(1L, true, false, "ACTIVE"));
        String name = staff.get(0).getDisplayName();

1.1.2. Generate API Client

The API client is built as part of the standard overall Fineract Gradle build. The client JAR can be found in fineract-client/build/libs as fineract-client.jar.

If you need to save time to incrementally work on making small changes to Swagger annotations in an IDE, you can execute e.g. the following line in root directory of the project to exclude non-require Gradle tasks:

./gradlew -x compileJava -x compileTest -x spotlessJava -x enhance resolve prepareInputYaml :fineract-client:buildJavaSdk

1.1.3. Validate OpenAPI Spec File

The resolve task in build.gradle file will generate the OpenAPI Spec File for the project. To make sure Swagger Codegen generates a correct library, it is important for the OpenAPI Spec file to be valid. Validation is done automatically by the OpenAPI code generator Gradle plugin. If you still have problems during code generation please use Swagger OpenAPI Validator to validate the spec file.

2. Testing

TBD

2.1. Cucumber

TBD

2.1.1. Introduction

TBD

2.1.2. Tutorial

TBD

2.1.3. Cheatsheet

TBD

2.2. Unit Testing

TBD

2.3. Integration Testing

TBD

3. Fineract Documentation Guide

TBD

3.1. File and Folder Layout

The general rules are
  • keep things as flat as possible (avoid sub-folders as much as possible)

  • DRY (don’t repeat yourself): don’t copy and paste code pieces, use AsciiDoc’s include feature and reference files/-sections from the project folder

  • images are located in fineract-doc/src/docs/en/images (or sub-folders)

  • diagrams are located in fineract-doc/src/docs/en/diagrams (or sub-folders)

  • specific chapters are located in fineract-doc/src/docs/en/chapters

  • every chapter has its own folder and at least one index.adoc file

  • it’s recommended to keep the chapters flat (i. e. no sub-folders in the chapter folders)

  • it’s recommended to create one file per chapter section; like that you can re-arrange sections very easily in the index.adoc file

These rules are not entirely set in stone and could be modified if necessary. If you see any issues then please report them on the mailing list or open a Jira ticket.

3.2. AsciiDoc

3.2.1. Cheatsheet

You can find the definitive manual on AsciiDoc syntax at AsciiDoc documentation. To help people get started, however, here is a simpler cheat sheet.

AsciiDoc vs Asciidoctor (format vs tool)

When we refer to AsciiDoc then we mean the language or format that this documentation is written in. AsciiDoc is a markup language similar to Markdown (but more powerful and expressive) designed for technical documentation. You don’t need necessarily any specialized editors or tools to write your documentation in AsciiDoc, a plain text editor will do, but there are plenty of choices that give you a better experience (in this documentation we describe the basic usage with AsciiDoc plugins for IntelliJ, Eclipse and VSCode).

Asciidoctor on the other hand is the command line tool we use to transform documents written in AsciiDoc into HTML and PDF (Epub3 and Docbook are also available). There are three variants available:

  • Asciidoctor (written in Ruby)

  • Asciidoctor.js (written in JavaScript, often used for browser previews)

  • AsciidoctorJ (Java lib that integrates the Ruby implementation via JRuby, e. g. the Asciidoctor Gradle plugin is based on that)

Sometimes you will still find documentation related to the original incarnation of AsciiDoc/tor (written in Python). The format evolved quite a bit since then and the tools try to maintain a certain degree of backward compatibility, but there is no guarantee. We prefer to use the latest language specs as documented here.
Basic AsciiDoc Syntax
Bold

Put asterisks around text to make it bold.

Italics

Use underlines on either side of a string to put text into italics.

Headings

Equal signs (=) are used for heading levels. Each equal sign is a level. Each page can only have one top level (i.e., only one section with a single =).

Levels should be appropriately nested. During the build, validation occurs to ensure that level 3s are preceded by level 2s, level 4s are preceded by level 3s, etc. Including out-of-sequence heading levels (such as a level 3 then a level 5) will not fail the build, but will produce an error.

Code Examples

Use backticks ` for text that should be monospaced, such as code or a class name in the body of a paragraph.

Longer code examples can be separated from text with source blocks.
These allow defining the syntax being used so the code is properly highlighted.

Example Source Block
[source,xml]
<field name="id" type="string" indexed="true" stored="true" required="true" multiValued="false" />

If your code block will include line breaks, put 4 hyphens (----) before and after the entire block.

Source Block Syntax Highlighting

The HTML output uses Rouge to add syntax highlighting to code examples. This is done by adding the language of the code block after the source, as shown in the above example source block (xml in that case).

Rouge has a long selection of lexers available. You can see the full list at github.com/rouge-ruby/rouge/wiki/List-of-supported-languages-and-lexers. Use one of the valid short names to get syntax highlighting for that language.

Ideally, we will have an appropriate lexer to use for all source blocks, but that’s not possible.
When in doubt, choose text, or leave it blank.

Importing Code Snippets from Other Files

The build system has the ability to "include" snippets located in other files — even non-AsciiDoc files such as *.java source code files.

We’ve configured a global attribute called {rootdir} that you can use to reference these files consistently from Fineract’s project root folder.

Snippets are bounded by tag comments placed at the start and end of the section you would like to import. Opening tags look like: // tag::snippetName[]. Closing tags follow the format: // end::snippetName[].

Snippets can be inserted into an .adoc file using an include directive, following the format: include::{rootdir}/<directory-under-root-folder>/<file-name>[tag=snippetName].

You could also use relative paths to reference include files, but it is preferred to always use the root folder as a starting point. Like this you can be sure that the preview in your editor of choice works.

For example, if we wanted to highlight a specific section of the following Cucumber test definition (more on that in section Cucumber Testing) ClasspathDuplicatesStepDefinitions.java file located under fineract-provider/src/test/java/org/apache/fineract/infrastructure/classpath/.

[source,java,indent=0]
----
include::{rootdir}/fineract-provider/src/test/java/org/apache/fineract/infrastructure/classpath/ClasspathDuplicatesStepDefinitions.java[tag=then]
----

For more information on the include directive, see the documentation at docs.asciidoctor.org/asciidoc/latest/directives/include.

Block Titles

Titles can be added to most blocks (images, source blocks, tables, etc.) by simply prefacing the title with a period (.). For example, to add a title to the source block example above:

.Example ID field
[source,xml]
<field name="id" type="string" indexed="true" stored="true" required="true" multiValued="false" />

When converting content to HTML, Asciidoctor will automatically render many link types (such as http: and mailto:) without any additional syntax. However, you can add a name to a link by adding the URI followed by square brackets:

http://fineract.apache.org/[Fineract Website]

A warning up front, linking to other pages can be a little painful. There are slightly different rules depending on the type of link you want to create, and where you are linking from. The build process includes a validation for internal or inter-page links, so if you can build the docs locally, you can use that to verify you constructed your link properly. With all the below examples, you can add text to display as the link title by putting the display text in brackets after the link, as in:

xref:indexing-guide:schema-api.adoc#modify-the-schema[Modify the Schema]

You can also use the title of the Page or Section you are linking to by using an empty display text.
This is useful in case the title of the page or section changes. In that case you won’t need to change the display text for every link that refers to that page/section.

See an example below:

xref:indexing-guide:schema-api.adoc#modify-the-schema[]
Link to a Section on the Same Page

To link to an anchor (or section title) on the same page, you can simply use double angle brackets (<< >>) around the anchor/heading/section title you want to link to. Any section title (a heading that starts with equal signs) automatically becomes an anchor during conversion and is available for deep linking.

Example

If I have a section on a page that looks like this (from process.adoc):

== Steps

Common parameters for all steps are:

To link to this section from another part of the same process.adoc page, I simply need to put the section title in double angle brackets, as in:

See also the <<Steps>> section.

The section title will be used as the display text; to customize that add a comma after the the section title, then the text you want used for display.

Link to a Section with an Anchor ID

When linking to any section (on the same page or another one), you must also be aware of any pre-defined anchors that may be in use (these will be in double brackets, like [[ ]]).
When the page is converted, those will be the references your link needs to point to.

Example

Take this example from configsets-api.adoc:

[[configsets-create]]
== Create a ConfigSet

To link to this section, there are two approaches depending on where you are linking from:

  • From the same page, simply use the anchor name: <<configsets-create>>.

  • From another page, use the page name and the anchor name: xref:configuration-guide:configsets-api.adoc#configsets-create[].

Link to Another Page

To link to another page or a section on another page, you must refer to the full filename and refer to the section you want to link to.

When you want to refer the reader to another page without deep-linking to a section, Asciidoctor allows this by merely omitting the # and section id.

Example

To construct a link to the process.adoc page, we need to refer to the file name (process.adoc), as well as the module that the file resides in (release/).

It’s preferred to also always use the page name to give the reader better context for where the link goes.
As in:

For more about upgrades, see xref:release:process.adoc[Fineract Release Process].
Link to Another Page in the same folder

If the page that contains the link and the page being linked to reside in the same module, there is no need to include the module name after xref:

Example

To construct a link to the process-step01.adoc page from process.adoc page, we do not need to include the module name because they both reside in the upgrade-notes module.

For more information on the first step of the release process, see the section \xref:process-step01.adoc[].
Link to a Section on Another Page

Linking to a section is the same conceptually as linking to the top of a page, you just need to take a little extra care to format the anchor ID in your link reference properly.

When you link to a section on another page, you must make a simple conversion of the title into the format of the section ID that will be created during the conversion. These are the rules that transform the sections:

Example

TBD

Ordered and Unordered Lists

AsciiDoc supports three types of lists:

  • Unordered lists

  • Ordered lists

  • Labeled lists

Each type of list can be mixed with the other types. So, you could have an ordered list inside a labeled list if necessary.

Unordered Lists

Simple bulleted lists need each line to start with an asterisk (*). It should be the first character of the line, and be followed by a space.

Ordered Lists

Numbered lists need each line to start with a period (.). It should be the first character of the line, and be followed by a space. This style is preferred over manually numbering your list.

Description Lists

These are like question & answer lists or glossary definitions.
Each line should start with the list item followed by double colons (::), then a space or new line. Labeled lists can be nested by adding an additional colon (such as :::, etc.). If your content will span multiple paragraphs or include source blocks, etc., you will want to add a plus sign (+) to keep the sections together for your reader.

We prefer this style of list for parameters because it allows more freedom in how you present the details for each parameter. For example, it supports ordered or unordered lists inside it automatically, and you can include multiple paragraphs and source blocks without trying to cram them into a smaller table cell.
Images

There are two ways to include an image: inline or as a block. Inline images are those where text will flow around the image. Block images are those that appear on their own line, set off from any other text on the page. Both approaches use the image tag before the image filename, but the number of colons after image define if it is inline or a block. Inline images use one colon (image:), while block images use two colons (image::). Block images automatically include a caption label and a number (such as Figure 1). If a block image includes a title, it will be included as the text of the caption. Optional attributes allow you to set the alt text, the size of the image, if it should be a link, float and alignment. We have defined a global attribute {imagesdir} to standardize the location for all images (fineract-doc/src/docs/en/images).

Tables

Tables can be complex, but it is pretty easy to make a basic table that fits most needs.

Basic Tables

The basic structure of a table is similar to Markdown, with pipes (|) delimiting columns between rows:

|===
| col 1 row 1 | col 2 row 1|
| col 1 row 2 | col 2 row 2|
|===

Note the use of |=== at the start and end. For basic tables that’s not exactly required, but it does help to delimit the start and end of the table in case you accidentally introduce (or maybe prefer) spaces between the rows.

Header Rows

To add a header to a table, you need only set the header attribute at the start of the table:

[options="header"]
|===
| header col 1 | header col 2|
| col 1 row 1 | col 2 row 1|
| col 1 row 2 | col 2 row 2|
|===
Defining Column Styles

If you need to define specific styles to all rows in a column, you can do so with the attributes.

This example will center all content in all rows:

[cols="2*^" options="header"]
|===
| header col 1 | header col 2|
| col 1 row 1 | col 2 row 1|
| col 1 row 2 | col 2 row 2|
|===

Alignments or any other styles can be applied only to a specific column. For example, this would only center the last column of the table:

[cols="2*,^" options="header"]
|===
| header col 1 | header col 2|
| col 1 row 1 | col 2 row 1|
| col 1 row 2 | col 2 row 2|
|===
More Options

Tables can also be given footer rows, borders, and captions. You can determine the width of columns, or the width of the table as a whole.

CSV or DSV can also be used instead of formatting the data in pipes.

Admonitions (Notes, Warnings)

AsciiDoc supports several types of callout boxes, called "admonitions":

  • NOTE

  • TIP

  • IMPORTANT

  • CAUTION

  • WARNING

It is enough to start a paragraph with one of these words followed by a colon (such as NOTE:). When it is converted to HTML, those sections will be formatted properly - indented from the main text and showing an icon inline.

You can add titles to admonitions by making it an admonition block. The structure of an admonition block is like this:

.Title of Note
[NOTE]
====
Text of note
====

In this example, the type of admonition is included in square brackets ([NOTE]), and the title is prefixed with a period. Four equal signs give the start and end points of the note text (which can include new lines, lists, code examples, etc.).

STEM Notation Support

We have set up the Ref Guide to be able to support STEM notation whenever it’s needed.

The AsciiMath syntax is supported by default, but LaTeX syntax is also available.

To insert a mathematical formula inline with your text, you can simply write:

stem:[a//b]

MathJax.js will render the formula as proper mathematical notation when a user loads the page. When the above example is converted to HTML, it will look like this to a user: \$a//b\$

To insert LaTeX, preface the formula with latexmath instead of stem:

latexmath:[tp \leq 1 - (1 - sim^{rows})^{bands}]

Long formulas, or formulas which should to be set off from the main text, can use the block syntax prefaced by stem or latexmath:

[stem]
++++
sqrt(3x-1)+(1+x)^2 < y
++++

or for LaTeX:

[latexmath]
++++
[tp \leq 1 - (1 - sim^{rows})^{bands}]
++++

3.3. Diagrams

TBD

3.3.1. PlantUML Cheatsheet

TBD

3.3.4. Vega Cheatsheet

TBD

3.5. Antora

TBD

4. Releases

How to Release Apache Fineract documents the process how we make the source code that is available here in this Git repository into a binary release tar.gz available on fineract.apache.org.

Diagram
Figure 4. Release Schedule

4.1. Configuration

Before you can start using the Fineract release plugin to create releases you have to configure and setup a couple of things first.

  • All official communication concerning releases happens on the mailing list. Every release manager needs to be a member of and engaging on the mailing list for credibility.

  • Make sure you have edit permissions on the Apache Confluence Wiki

  • You need full permissions on Apache JIRA to be able to move issues to the next release

  • Git committer privileges to be allowed to create tags and the release branch

  • Familiarity with building Fineract locally and creating release distributions is required

  • You need to be a member of the PMC to be able to upload release artifacts; this task can be delegated though

  • A general Familiarity with PGP/GPG is recommended (at least to setup your keypairs), but the release plugin does most of the heavy lifting

  • Make sure to read the release plugin documentation for troubleshooting

4.1.1. Secrets

TBD

Infrastructure Team

A couple of secrets for third party services are automatically configured by the infrastructure team at The Apache Foundation for the Fineract Github account. At the moment this includes environment variables for:

  • Github token (e. g. to publish Github Pages, use the Github API in Github Actions)

  • Docker Hub token (to publish our Docker images)

  • Sonar Cloud token (for our code quality reports)

See also:

Lastpass

It seems that Apache has some kind of org account or similar. Popped up a couple of times in the infrastructure documentation.

TBD

1Password

Other Fineract development related secrets, e. g. for deployments of demo systems on Google Cloud, AWS etc. are managed in a team account at 1Password. At the moment the following committers are members of the 1Password team account:

If you need access or have any questions related to those secrets then please reach out to one of the team members.

4.1.2. GPG

Generate GPG key pairs if you don’t already have them and publish them. Please use your Apache email address when creating your GPG keypair. If you already have configured GPG and associated your keypair with a non-Apache email address then please consider creating a separate one just for all things related to Fineract (or Apache in general).

Instructions:

  1. Check your GPG version:

    Input GPG version
    gpg --version
    Output GPG version
    gpg (GnuPG) 2.2.27
    libgcrypt 1.9.4
    Copyright (C) 2021 Free Software Foundation, Inc.
    License GNU GPL-3.0-or-later <https://gnu.org/licenses/gpl.html>
    This is free software: you are free to change and redistribute it.
    There is NO WARRANTY, to the extent permitted by law.
    
    Home: /home/aleks/.gnupg
    Supported algorithms:
    Pubkey: RSA, ELG, DSA, ECDH, ECDSA, EDDSA
    Cipher: IDEA, 3DES, CAST5, BLOWFISH, AES, AES192, AES256, TWOFISH,
            CAMELLIA128, CAMELLIA192, CAMELLIA256
    Hash: SHA1, RIPEMD160, SHA256, SHA384, SHA512, SHA224
    Compression: Uncompressed, ZIP, ZLIB, BZIP2
    The insecure hash algorithm SHA1 is still supported in version 2.2.27. SHA1 is obsolete and you don’t want to use it to generate your signature.
  2. Generate your GPG key pair:

    Input generate GPG key pair
    gpg --full-gen-key
    Output generate GPG key pair (step 1: key type selection)
    gpg (GnuPG) 2.2.27; Copyright (C) 2021 Free Software Foundation, Inc.
    This is free software: you are free to change and redistribute it.
    There is NO WARRANTY, to the extent permitted by law.
    
    Please select what kind of key you want:
       (1) RSA and RSA (default)
       (2) DSA and Elgamal
       (3) DSA (sign only)
       (4) RSA (sign only)
      (14) Existing key from card
    Your selection?

    There are four options. The default is to use RSA to create the key pair. Good enough for us.

    Output generate GPG key pair (step 2: key length selection)
    RSA keys may be between 1024 and 4096 bits long.
    What keysize do you want? (2048)

    The default key length is 2048 bits. 1024 is obsolete and a longer 4096 RSA key will not provide more security than 2048 RSA key. Use the default.

    Output generate GPG key pair (step 3: validity selection)
    Requested keysize is 2048 bits
    Please specify how long the key should be valid.
     0 = key does not expire
     <n> = key expires in n days
     <n>w = key expires in n weeks
     <n>m = key expires in n months
     <n>y = key expires in n years
    Key is valid for? (0)2y

    2 years for the validity of your keys should be fine. You can always update the expiration time later on.

    Output generate GPG key pair (step 4: confirmation)
    Key expires at Sun 16 Apr 2024 08:10:24 PM UTC
    Is this correct? (y/N)y

    Confirm if everything is correct.

    Output generate GPG key pair (step 5: provide user details)
    GnuPG needs to construct a user ID to identify your key.
    Real name: Aleksandar Vidakovic
    Email address: aleks@apache.org
    Comment:

    Provide your user details for the key. This is important because this information will be included in our key. It’s one way of indicating who is owner of this key. The email address is a unique identifier for a person. You can leave Comment blank.

    Output generate GPG key pair (step 6: user ID selection)
    You selected this USER-ID:
    "Aleksandar Vidakovic <aleks@apache.org>"
    Change (N)ame, (C)omment, (E)mail or (O)kay/(Q)uit? O

    Select Okay.

    After the selection of your user ID GPG will ask for a passphrase to protect your private key. Maybe time to open your password manager and generate a secure one and save it in your vault. Once you’ve confirmed your password GPG will start to generate your keys.

    Don’t lose your private key password. You won’t be able to unlock and use your private key without it.
    Output generate GPG key pair (step 7: gpg key pair generation)
    We need to generate a lot of random bytes. It is a good idea to perform
    some other action (type on the keyboard, move the mouse, utilize the
    disks) during the prime generation; this gives the random number
    generator a better chance to gain enough entropy.

    Generating the GPG keys will take a while.

    Output generate GPG key pair (step 8: gpg key pair finished)
    gpg: key 7890ABCD marked as ultimately trusted (1)
    gpg: directory '/home/aleks/.gnupg/openpgp-revocs.d' created
    gpg: revocation certificate stored as '/home/aleks/.gnupg/openpgp-revocs.d/ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890ABCD.rev' (2)
    public and secret key created and signed.
    
    gpg: checking the trustdb
    gpg: marginals needed: 3 completes needed: 1 trust model: PGP
    gpg: depth: 0 valid: 1 signed: 0 trust: 0-, 0q, 0n, 0m, 0f, 1u
    gpg: next trustdb check due at 2024-04-16
    pub rsa2048/7890ABCD 2022-04-16 [S] [expires: 2024-04-16] (3)
    Key fingerprint = ABCD EFGH IJKL MNOP QRST UVWX YZ12 3456 7890 ABCD (4)
    uid     [ultimate] Aleksandar Vidakovic <aleks@apache.org> (5)
    sub rsa2048/4FGHIJ56 2022-04-16 [] [expires: 2024-04-16]
    1 GPG created a unique identifier in HEX format for your public key. When someone wants to download your public key, they can refer to it either with your email address or this HEX value.
    2 GPG created a revocation certificate and its directory. You should never share your private key. If your private key is compromised, you need to use your revocation certificate to revoke your key.
    3 The public key is 2048 bits using RSA algorithm and shows the expiration date of 16 Apr 2024. The public key ID 7890ABCD matches the last 8 bits of key fingerprint.
    4 The key fingerprint (ABCD EFGH IJKL MNOP QRST UVWX YZ12 3456 7890 ABCD) is a hash of your public key.
    5 Your name and your email address are shown with information about the subkey.

    Now you can find that there are two files created under ~/.gnupg/private-keys-v1.d/ directory. These two files are binary files with .key extension.

  3. Export your public key:

    gpg --armor --export aleks@apache.org > pubkey.asc
  4. Export Your Private Key:

    gpg --export-secret-keys --armor aleks@apache.org > privkey.asc
  5. Protect Your Private Key and Revocation Certificate

    Your private key should be kept in a safe place, like an encrypted flash drive. Treat it like your house key. Only you can have it and don’t lose it. And you must remember your passphrase, otherwise you can’t unlock your private key.

    You should protect your revocation certificate. Anyone in posession of your revocation certificate, could immediately revoke your public/private key pair and generate fake ones.

Please contact a PMC member to add your GPG public key in Fineract’s Subversion repository. This is necessary to be able to validate published releases.
  1. Upload your GPG key to a keyserver:

    gpg --send-keys ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890ABCD

    Before doing this, make sure that your default keyserver is hkp://keyserver.ubuntu.com/. You can do this by changing the default keyserver in ~/.gnupg/dirmngr.conf:

    keyserver hkp://keyserver.ubuntu.com/

    Alternatively you can provide the keyserver whith the send command:

    gpg --keyserver 'hkp://keyserver.ubuntu.com:11371' --send-keys ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890ABCD

    Another option to publish your key is to submit an armored public key directly at keyserver.ubuntu.com/. You can create the necessary data with this command by providing the email address that you used when you created your key pair:

    gpg --armor --export aleks@apache.org

    Output:

    -----BEGIN PGP PUBLIC KEY BLOCK-----
    
    mQINBF8iGq0BEADGRqeSsOoNDc1sV3L9sQ34KhmoQrACnMYGztx33TD98aWplul+
    jm8uGtMmBus4DJJJap1bVQ1oMehw2mscmDHpfJjLNZ/q+vUqbExx1/CER7XvLryN
    <--- snip --->
    2nHBuBftxDRpDHQ+O5XYwSDSTDMmthPjx0vJGBH4K1kO8XK99e01A6/oYLV2SMKp
    gXXeWjafxBmHT1cM8hoBZBYzgTu9nK5UnllWunfaHXiCBG4oQQ==
    =85/F
    -----END PGP PUBLIC KEY BLOCK-----

    = Email

Official communication related to releases needs to be done with an Apache email address. The Apache Foundation doesn’t provide any real email inboxes anymore and just relays emails to your configured private account (GMail etc.).

At the moment we are supporting only GMail accounts. Please let us know if you have other configuration recipes for other email providers.
GMail

You can configure your GMail account and add another profile to use the Apache relay server if you need to send official messages. Please follow these instructions:

TBD.

To be able to send emails via SMTP with your GMail account you probably need to create an app password. Please follow these instructions:

  1. Go to your Google Account.

  2. Select Security.

  3. Under "Signing in to Google," select App Passwords. You may need to sign in. If you don’t have this option, it might be because:

  4. 2-Step Verification is not set up for your account.

  5. 2-Step Verification is only set up for security keys.

  6. Your account is through work, school, or other organization.

  7. You turned on Advanced Protection.

  8. At the bottom, choose Select app and choose the app you using and then Select device and choose the device you’re using and then Generate.

  9. Follow the instructions to enter the App Password. The App Password is the 16-character code in the yellow bar on your device.

  10. Tap Done.

See also: Google Support: Sign in with App Passwords for more details.

Gradle

TBD

User Properties

There are a couple of properties that contain committer/release manager related secrets. Please add the following properties to your personal global Gradle properties (you will find them at ~/.gradle/gradle.properties in your home folder).

fineract.config.gnupg.keyName=ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890ABCD(1)
fineract.config.gnupg.password=******
fineract.config.gnupg.publicKeyring=~/.gnupg/pubring.kbx(2)
fineract.config.gnupg.secretKeyring=~/.gnupg/secring.gpg
fineract.config.smtp.username=aleks@gmail.com (3)
fineract.config.smtp.password=******
fineract.config.name=Aleksandar Vidakovic
fineract.config.email=aleks@apache.org
fineract.config.username=aleks (4)
fineract.config.password=******
1 Make sure you use the full GPG key name (you can list yours via gpg --list-secret-keys --keyid-format=long)
2 GnuPG has it’s own kbx format to store the public key ring. At the moment we are only supporting this format
3 Currently we only have instructions for GMail
4 Apache committer credentials
Never add any personal secrets in the project gradle.properties. Double check that you are not accidentally committing them to Git!
Release Plugin

Creating Apache Fineract releases was a very manual and tedious procedure before we created the Gradle release plugin. It was easy - even with documentation - to forget a detail. Some ideas are borrowed from the excellent JReleaser tool. Unfortunately at the moment we can’t use it for the full release process. Being an Apache project we have certain requirements that are not fully covered by JReleaser.

Release Plugin Configuration
        git {
            dir = "${projectDir.absolutePath}/.git"
            sections = [
                [
                    section: "user",
                    name: "name",
                    value: "${findProperty('fineract.config.name')}",
                ],
                [
                    section: "user",
                    name: "email",
                    value: "${findProperty('fineract.config.email')}",
                ],
                [
                    section: "user",
                    name: "signingkey",
                    value: "${findProperty('fineract.config.gnupg.keyName')}",
                ],
                [
                    section: "commit",
                    name: "gpgsign",
                    value: "true",
                ],
            ]
        }
        template {
            templateDir = "${projectDir}/buildSrc/src/main/resources"
        }
        gpg {
            keyName = "${findProperty('fineract.config.gnupg.keyName')}"
            publicKeyring = "${findProperty('fineract.config.gnupg.publicKeyring')}"
            secretKeyring = "${findProperty('fineract.config.gnupg.secretKeyring')}"
            password = "${findProperty('fineract.config.gnupg.password')}"
        }
        smtp {
            host = 'smtp.gmail.com'
            username = "${findProperty('fineract.config.smtp.username')}"
            password = "${findProperty('fineract.config.smtp.password')}"
            tls = true
            ssl = true
        }
        subversion {
            username = "${findProperty('fineract.config.username')}"
            password = "${findProperty('fineract.config.password')}"
            revision = 'HEAD'
        }
        jira {
            url = 'https://issues.apache.org/jira/rest/api/2/'
            username = "${findProperty('fineract.config.username')}"
            password = "${findProperty('fineract.config.password')}"
        }
        confluence {
            url = 'https://cwiki.apache.org/confluence/rest/api/'
            username = "${findProperty('fineract.config.username')}"
            password = "${findProperty('fineract.config.password')}"
        }
    }

    steps = [
        test: [
            order: 0,
            description: 'Test',
            email: [
                from: "${findProperty('fineract.config.email')}",
                to: "${findProperty('fineract.config.email')}",
                mime: 'text/plain',
                subject: "[FINERACT] [TEST] ๐Ÿ“ฃ ๐Ÿ ๐Ÿ—ณ๏ธ ๐Ÿš€ ๐Ÿ“ˆ ๐Ÿ”€ ๐ŸŒ  Propose new release ${version}",
                messageTemplate: [
                    templateFile: "${projectDir}/buildSrc/src/main/resources/email/release.step01.headsup.message.ftl"
                ]
            ],
            subversion: [
                url: 'https://dist.apache.org/repos/dist/dev/fineract',
                directory: "${System.getProperty("java.io.tmpdir")}"

4.2. Release Process

TODO:

  • create "Jira anchor ticket" with all issues linked that are going into this release.

  • maintenance: continuously update the "Jira anchor ticket" to make sure we catch all ticket changes

  • maintenance: list tickets that have discrepancies, e. g. tickets still open while associated PR merged, ticket on wrong version (i. e. associated PR already merged before with another release).

TBD

Consider the Gradle plugin commands an experimental feature!
Diagram
Figure 5. Release Process Diagram

4.2.1. Step 1: Heads-Up Email

Description

The RM should, if one doesn’t already exist, first create a new release umbrella issue in JIRA. This issue is dedicated to tracking (a summary of) any discussion related to the planned new release. An example of such an issue is FINERACT-873 - Release Apache Fineract v1.4.0 RESOLVED.

The RM then creates an list of resolved issues & features through an initial check in JIRA for already resolved issues for the release, and then setup a timeline for release branch point. The time for the day the issue list is created to the release branch point must be at least two weeks in order to give the community a chance to prioritize and commit any last minute features and issues they would like to see in the upcoming release.

The RM must then send the pointer to the umbrella issue along with the tentative timeline for branch point to the developer lists. Any work identified as release related that needs to be completed should be added as a sub tasks of the umbrella issue to allow all developers and users to see the overall release progress in one place. The umbrella issue shall also link to any issues still requiring clarification whether or not they will make it into the release.

The RM should then inform users when the git branch is planned to be created, by sending an email based on this template:

<#--

    Licensed to the Apache Software Foundation (ASF) under one
    or more contributor license agreements. See the NOTICE file
    distributed with this work for additional information
    regarding copyright ownership. The ASF licenses this file
    to you under the Apache License, Version 2.0 (the
    "License"); you may not use this file except in compliance
    with the License. You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing,
    software distributed under the License is distributed on an
    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    KIND, either express or implied. See the License for the
    specific language governing permissions and limitations
    under the License.

-->
[FINERACT] [PROPOSAL] ๐Ÿ“ฆ New release ${project['fineract.release.version']}

<#--

    Licensed to the Apache Software Foundation (ASF) under one
    or more contributor license agreements. See the NOTICE file
    distributed with this work for additional information
    regarding copyright ownership. The ASF licenses this file
    to you under the Apache License, Version 2.0 (the
    "License"); you may not use this file except in compliance
    with the License. You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing,
    software distributed under the License is distributed on an
    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    KIND, either express or implied. See the License for the
    specific language governing permissions and limitations
    under the License.

-->
Hello everyone,

... based on our "How to Release Apache Fineract" process documented at https://cwiki.apache.org/confluence/x/DRwIB:

I will create a ${project['fineract.release.version']} branch off develop in our git repository at https://github.com/apache/fineract on ${project['fineract.release.date']}.

The release tracking umbrella issue for tracking all activity in JIRA is FINERACT-${project['fineract.release.issue']!'0000'} (https://issues.apache.org/jira/browse/FINERACT-${project['fineract.release.issue']!'0000'}) for this Fineract ${project['fineract.release.version']}.

If you have any work in progress that you would like to see included in this release, please add "blocking" links to the release JIRA issue.

I am the release manager for this release.

Cheers,

${project['fineract.config.name']}



๐ŸŽ‰ Powered by Fineract Release Plugin ๐ŸŽŠ
Gradle Task
Command
% ./gradlew fineractReleaseStep1 -Pfineract.release.issue=1234 -Pfineract.release.date="Monday, April 25, 2022" -Pfineract.release.version=1.6.1-107c2290

4.2.2. Step 2: Clean Up JIRA

Description

Before a release is done, make sure that any issues that are fixed have their fix version setup correctly.

project = FINERACT and resolution = fixed and fixVersion is empty

Move all unresolved JIRA issues which have this release as Fix Version to the next release

project = FINERACT and fixVersion = 1.6.1-107c2290 and status not in ( Resolved, Done, Accepted, Closed )

You can also run the following query to make sure that the issues fixed for the to-be-released version look accurate:

project = FINERACT and fixVersion = 1.6.1-107c2290

Finally, check out the output of the JIRA release note tool to see which tickets are included in the release, in order to do a sanity check.

Gradle Task
Command
% ./gradlew fineractReleaseStep2 -Pfineract.release.version=1.6.1-107c2290
This task is not yet automated!

4.2.3. Step 3: Create Release Branch

Description

Communicate with the community. You do not need to start a new email thread on the developer mailing list to notify that you are about to branch, just do it ca. 2 weeks after the initial email, or later, based on the discussion on the initial email.

You do not need to ask committers to hold off any commits until you have branched finished, as it’s always possible to fast-forward the branch to latest develop, or cherry-pick last minute changes to it. People should be able to continue working on the develop branch on bug fixes and great new features for the next release while the release process for the current release is being worked through.

  1. Clone fresh repository copy

    % git clone git@github.com:apache/fineract.git
    % cd fineract
  2. Check that current HEAD points to commit on which you want to base new release branch. Checkout a particular earlier commit if not.

    % git log (1)
    1 Check current branch history. HEAD should point to commit that you want to be base for your release branch
  3. Create a new release branch with name "$Version"

    % git checkout -b 1.6.1-107c2290
  4. Push new branch to Apache Fineract repository

    % git push origin 1.6.1-107c2290
  5. Add new release notes in Release Folders. The change list can be swiped from the JIRA release note tool (use the "text" format for the change log). See JIRA Cleanup above to ensure that the release notes generated by this tool are what you are expecting.

  6. Send en email announcing the new release branch on the earlier email thread

    <#--
    
        Licensed to the Apache Software Foundation (ASF) under one
        or more contributor license agreements. See the NOTICE file
        distributed with this work for additional information
        regarding copyright ownership. The ASF licenses this file
        to you under the Apache License, Version 2.0 (the
        "License"); you may not use this file except in compliance
        with the License. You may obtain a copy of the License at
    
        http://www.apache.org/licenses/LICENSE-2.0
    
        Unless required by applicable law or agreed to in writing,
        software distributed under the License is distributed on an
        "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
        KIND, either express or implied. See the License for the
        specific language governing permissions and limitations
        under the License.
    
    -->
    [FINERACT] [ANNOUNCE] ๐Ÿ”€ ${project['fineract.release.version']} release branch
    
    <#--
    
        Licensed to the Apache Software Foundation (ASF) under one
        or more contributor license agreements. See the NOTICE file
        distributed with this work for additional information
        regarding copyright ownership. The ASF licenses this file
        to you under the Apache License, Version 2.0 (the
        "License"); you may not use this file except in compliance
        with the License. You may obtain a copy of the License at
    
        http://www.apache.org/licenses/LICENSE-2.0
    
        Unless required by applicable law or agreed to in writing,
        software distributed under the License is distributed on an
        "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
        KIND, either express or implied. See the License for the
        specific language governing permissions and limitations
        under the License.
    
    -->
    Hello everyone,
    
    ... as previously announced, I've just created the release branch for our upcoming ${project['fineract.release.version']} release.
    
    You can continue working and merging PRs to the develop branch for future releases, as always.
    
    The DRAFT release notes are on https://cwiki.apache.org/confluence/display/FINERACT/${project['fineract.release.version']}+-+Apache+Fineract.  Does anyone see anything missing?
    
    Does anyone have any last minutes changes they would like to see cherry-picked to branch ${project['fineract.release.version']}, or are we good go and actually cut the release based on this branch as it is?
    
    I'll initiate the final stage of actually creating the release on ${project['fineract.release.date']} if nobody objects.
    
    Cheers,
    
    ${project['fineract.config.name']}
Gradle Task
Command
% ./gradlew fineractReleaseStep3 -Pfineract.release.date="Monday, May 10, 2022" -Pfineract.release.version=1.6.1-107c2290

4.2.4. Step 4: Freeze JIRA

Description

You first need to close the release in JIRA so that the about to be released version cannot be used as "fixVersion" for new bugs anymore. Go to JIRA "Administer project" page and follow "Versions" in left menu. Table with list of all releases should appear, click on additional menu on the right of your release and choose "Release" option. Submit release date and you’re done.

Gradle Task
Command
% ./gradlew fineractReleaseStep4
This task is not yet automated!

4.2.5. Step 5: Create Release Tag

Description

Next, you create a git tag from the HEAD of the release’s git branch.

% git checkout 1.6.1-107c2290
% ./gradlew clean integrationTests <1>
% git tag -a 1.6.1-107c2290 -m "Fineract 1.6.1-107c2290 release"
% git push origin 1.6.1-107c2290
1 Run additonally manual tests with the community app.
It is important to create so called annotated tags (vs. lightweight) for releases.
Gradle Task
Command
% ./gradlew fineractReleaseStep5 -Pfineract.release.version=1.6.1-107c2290

4.2.6. Step 6: Create Distribution

Description

Create source and binary artifacts. Make sure to do some sanity checks. The tar and the release branch should match.

% cd /fineract-release-preparations <1>
% tar -xvf apache-fineract-1.6.1-107c2290-src.tar.gz
% git clone https://git-wip-us.apache.org/repos/asf/fineract.git
% cd fineract/
% git checkout tags/1.6.1-107c2290
% cd ..
% diff -r fineract apache-fineract-1.6.1-107c2290-src
1 Do a fresh clone of the tag.

Make sure code compiles and tests pass on the uncompressed source.

% cd apache-fineract-1.6.1-107c2290-src/fineract-provider <1>
% gradlew clean integrationTest <2>
% gradlew clean build <3>
% gradlew rat <4>
1 Make sure prerequisites are met before running these commands.
2 For running integration tests
3 For building deploy able war
4 For RAT checks
Gradle Task
Command
% ./gradlew fineractReleaseStep6

4.2.7. Step 7: Sign Distribution

Description

All release artifacts must be signed. In order to sign a release you will need a PGP key. You should get your key signed by a few other people. You will also need to receive their keys from a public key server. See the Apache release signing page for more details. Please follow the steps defined in Release Sign.

% gpg --armor --output apache-fineract-1.6.1-107c2290-src.tar.gz.asc --detach-sig apache-fineract-1.6.1-107c2290-src.tar.gz
% gpg --print-md MD5 apache-fineract-1.6.1-107c2290-src.tar.gz > apache-fineract-1.6.1-107c2290-src.tar.gz.md5
% gpg --print-md SHA512 apache-fineract-1.6.1-107c2290-src.tar.gz > apache-fineract-1.6.1-107c2290-src.tar.gz.sha512
% gpg --armor --output apache-fineract-1.6.1-107c2290--binary.tar.gz.asc --detach-sig apache-fineract-1.6.1-107c2290-binary.tar.gz
% gpg --print-md MD5 apache-fineract-1.6.1-107c2290-binary.tar.gz > apache-fineract-1.6.1-107c2290-binary.tar.gz.md5
% gpg --print-md SHA512 apache-fineract-1.6.1-107c2290-binary.tar.gz > apache-fineract-1.6.1-107c2290-binary.tar.gz.sha512
Gradle Task
Command
% ./gradlew fineractReleaseStep7

4.2.8. Step 8: Upload Distribution Staging

Description

Finally create a directory with release name (1.6.1-107c2290 in this example) in dist.apache.org/repos/dist/dev/fineract and add the following files in this new directory:

  • apache-fineract-1.6.1-107c2290-binary.tar.gz.sha

  • apache-fineract-1.6.1-107c2290-binary.tar.gz

  • apache-fineract-1.6.1-107c2290-binary.tar.gz.asc

  • apache-fineract-1.6.1-107c2290-binary.tar.gz.md5

  • apache-fineract-1.6.1-107c2290-src.tar.gz.sha

  • apache-fineract-1.6.1-107c2290-src.tar.gz

  • apache-fineract-1.6.1-107c2290-src.tar.gz.asc

  • apache-fineract-1.6.1-107c2290-src.tar.gz.md5

Upload binary and source archives to ASF’s distribution dev (staging) area:

% svn co https://dist.apache.org/repos/dist/dev/fineract/ fineract-dist-dev
% mkdir fineract-dist-dev/1.6.1-107c2290
% cp fineract/build/distributions/* fineract-dist-dev/1.6.1-107c2290/
% svn commit
You will need your ASF Committer credentials to be able to access the Subversion host dist.apache.org via.
Gradle Task
Command
% ./gradlew fineractReleaseStep8 -Pfineract.release.version=1.6.1-107c2290

4.2.9. Step 9: Verify Distribution Staging

Description

Following are the typical things we need to verify before voting on a release candidate. And the release manager should verify them too before calling out a vote.

Make sure release artifacts are hosted at dist.apache.org/repos/dist/dev/fineract

  • Release candidates should be in format apache-fineract-1.6.1-107c2290-binary.tar.gz

  • Verify signatures and hashes. You may have to import the public key of the release manager to verify the signatures. (gpg --recv-key <key id>)

  • Git tag matches the released bits (diff -rf)

  • Can compile successfully from source

  • Verify DISCLAIMER, NOTICE and LICENSE (year etc)

  • All files have correct headers (Rat check should be clean - gradlew rat)

  • No jar files in the source artifacts

  • Integration tests should work

Gradle Task
Command
% ./gradlew fineractReleaseStep9 -Pfineract.release.version=1.6.1-107c2290
This task is not yet automated!

4.2.10. Step 10: Start Vote

Description

Voting has to be done on dev@fineract.apache.org. You can close the vote after voting period expires (72 hours) and you accumulate sufficient votes (minimum 3 x +1 PMC votes).

<#--

    Licensed to the Apache Software Foundation (ASF) under one
    or more contributor license agreements. See the NOTICE file
    distributed with this work for additional information
    regarding copyright ownership. The ASF licenses this file
    to you under the Apache License, Version 2.0 (the
    "License"); you may not use this file except in compliance
    with the License. You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing,
    software distributed under the License is distributed on an
    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    KIND, either express or implied. See the License for the
    specific language governing permissions and limitations
    under the License.

-->
[FINERACT] [VOTE] ๐Ÿ—ณ๏ธ ${project['fineract.release.version']} for release

<#--

    Licensed to the Apache Software Foundation (ASF) under one
    or more contributor license agreements. See the NOTICE file
    distributed with this work for additional information
    regarding copyright ownership. The ASF licenses this file
    to you under the Apache License, Version 2.0 (the
    "License"); you may not use this file except in compliance
    with the License. You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing,
    software distributed under the License is distributed on an
    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    KIND, either express or implied. See the License for the
    specific language governing permissions and limitations
    under the License.

-->
Hello everyone,

... we have created Apache Fineract ${project['fineract.release.version']} release, with the artifacts below up for a vote.

It fixes the following issues: https://cwiki.apache.org/confluence/display/FINERACT/${project['fineract.release.version']}+-+Apache+Fineract

Source & Binary files : https://dist.apache.org/repos/dist/dev/fineract/${project['fineract.release.version']}/

Tag to be voted on (rc#): https://gitbox.apache.org/repos/asf?p=fineract.git;a=commit;h=refs/heads/${project['fineract.release.version']}

Fineract's KEYS containing the PGP key we used to sign the release: https://dist.apache.org/repos/dist/dev/fineract/KEYS

Note that this release contains source and binary artifacts.

This vote will be open for 72 hours:

[ ] +1 approve
[ ] +0 no opinion
[ ] -1 disapprove (and reason why)

Cheers,

${project['fineract.config.name']}
Gradle Task
Command
% ./gradlew fineractReleaseStep10 -Pfineract.release.version=1.6.1-107c2290

4.2.11. Step 11: Finish Vote

Description

Upon receiving 3 x +1 from the PMC, or after 72 hours (whichever one comes first), reply to the voting thread and add the prefix "[RESULT]" to the subject line with the results, as follows:

<#--

    Licensed to the Apache Software Foundation (ASF) under one
    or more contributor license agreements. See the NOTICE file
    distributed with this work for additional information
    regarding copyright ownership. The ASF licenses this file
    to you under the Apache License, Version 2.0 (the
    "License"); you may not use this file except in compliance
    with the License. You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing,
    software distributed under the License is distributed on an
    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    KIND, either express or implied. See the License for the
    specific language governing permissions and limitations
    under the License.

-->
[FINERACT] [VOTE] [RESULT] ๐Ÿงพ๏ธ ${project['fineract.release.version']} for release

<#--

    Licensed to the Apache Software Foundation (ASF) under one
    or more contributor license agreements. See the NOTICE file
    distributed with this work for additional information
    regarding copyright ownership. The ASF licenses this file
    to you under the Apache License, Version 2.0 (the
    "License"); you may not use this file except in compliance
    with the License. You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing,
    software distributed under the License is distributed on an
    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    KIND, either express or implied. See the License for the
    specific language governing permissions and limitations
    under the License.

-->
<#if (project['fineract.vote'].approve.binding?size + project['fineract.vote'].approve.nonBinding?size > project['fineract.vote'].disapprove.binding?size + project['fineract.vote'].disapprove.nonBinding?size)>
Voting is now closed and has passed with the following tally,

Binding +1s: ${project['fineract.vote'].approve.binding?size}
Non binding +1s: ${project['fineract.vote'].approve.nonBinding?size}
<#else>
Voting is now closed and has not passed with the following tally,

Binding +1s: ${project['fineract.vote'].approve.binding?size}
Non binding +1s: ${project['fineract.vote'].approve.nonBinding?size}

Binding -1s: ${project['fineract.vote'].disapprove.binding?size}
Non binding -1s: ${project['fineract.vote'].disapprove.nonBinding?size}
</#if>

Here are the detailed results:

<#list project['fineract.vote'].approve.binding>
Binding +1s:
    <#items as item>
- ${item.name} (${item.email})
    </#items>
</#list>


<#list project['fineract.vote'].approve.nonBinding>
Non binding +1s:
    <#items as item>
- ${item.name} (${item.email})
    </#items>
</#list>


<#list project['fineract.vote'].disapprove.binding>
Binding -1s:
    <#items as item>
- ${item.name} (${item.email})
    </#items>
</#list>

<#list project['fineract.vote'].disapprove.nonBinding>
Non binding -1s:
    <#items as item>
- ${item.name} (${item.email})
    </#items>
</#list>


<#list project['fineract.vote'].noOpinion.binding>
Binding +0s:
    <#items as item>
- ${item.name} (${item.email})
    </#items>
</#list>

<#list project['fineract.vote'].noOpinion.nonBinding>
Non binding +0s:
    <#items as item>
- ${item.name} (${item.email})
    </#items>
</#list>

<#if (project['fineract.vote'].approve.binding?size + project['fineract.vote'].approve.nonBinding?size > project['fineract.vote'].disapprove.binding?size + project['fineract.vote'].disapprove.nonBinding?size)>
Thanks to everyone who voted! I'll now continue with the rest of the release process.
<#else>
Thanks to everyone who voted! Looks like we have to repeat the vote.
</#if>

${project['fineract.config.name']}
Gradle Task
Command
% ./gradlew fineractReleaseStep11 -Pfineract.release.version=1.6.1-107c2290

4.2.12. Step 12: Upload Distribution Release

Description

In order to release you have to checkout release repository located on dist.apache.org/repos/dist/release/fineract and add release artifacts there.

% svn co https://dist.apache.org/repos/dist/release/fineract fineract-release
% mkdir fineract-release/1.6.1-107c2290/
% cp fineract-dist-dev/1.6.1-107c2290/* fineract-release/1.6.1-107c2290/
% svn add fineract-release/1.6.1-107c2290/
% svn commit -m "Fineract Release 1.6.1-107c2290" fineract-release/1.6.1-107c2290/

You will now get an automated email from the Apache Reporter Service (no-reply@reporter.apache.org), subject "Please add your release data for 'fineract'" to add the release data (version and date) to the database on reporter.apache.org/addrelease.html?fineract (requires PMC membership).

Gradle Task
Command
% ./gradlew fineractReleaseStep12 -Pfineract.release.version=1.6.1-107c2290

4.2.13. Step 13: Close Release Branch

Description

As discussed in FINERACT-1154, now that everything is final, please do the following to remove the release branch (and just keep the tag), and make sure that everything on the release tag is merged to develop and that e.g. git describe works:

% git checkout develop
% git branch -D 1.6.1-107c2290
% git push origin :1.6.1-107c2290
% git checkout develop
% git checkout -b merge-1.6.1-107c2290
% git merge -s recursive -Xignore-all-space 1.6.1-107c2290  <1>
% git commit
% git push $USER
% hub pull-request
1 Manually resolve merge conflicts, if any
Gradle Task
Command
% ./gradlew fineractReleaseStep13 -Pfineract.release.version=1.6.1-107c2290
This task is not yet automated!

4.2.14. Step 14: Update website

Description

Finally update the fineract.apache.org website with the latest release details. The website’s HTML source code is available at github.com/apache/fineract-site.

This step is not yet updated. We are working on a static site generator setup.
Gradle Task
Command
% ./gradlew fineractReleaseStep14 (1)
1 Currently doing nothing. Will trigger in the future the static site generator and publish on Github.
This task is not yet automated!

4.2.15. Step 15: Announcement Email

Description

Send an email to announce@apache.org (sender address must be @apache.org):

<#--

    Licensed to the Apache Software Foundation (ASF) under one
    or more contributor license agreements. See the NOTICE file
    distributed with this work for additional information
    regarding copyright ownership. The ASF licenses this file
    to you under the Apache License, Version 2.0 (the
    "License"); you may not use this file except in compliance
    with the License. You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing,
    software distributed under the License is distributed on an
    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    KIND, either express or implied. See the License for the
    specific language governing permissions and limitations
    under the License.

-->
[ANNOUNCE] Apache Fineract ${project['fineract.release.version']} Release

<#--

    Licensed to the Apache Software Foundation (ASF) under one
    or more contributor license agreements. See the NOTICE file
    distributed with this work for additional information
    regarding copyright ownership. The ASF licenses this file
    to you under the Apache License, Version 2.0 (the
    "License"); you may not use this file except in compliance
    with the License. You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing,
    software distributed under the License is distributed on an
    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    KIND, either express or implied. See the License for the
    specific language governing permissions and limitations
    under the License.

-->
The Apache Fineract project is pleased to announce
the release of Apache Fineract ${project['fineract.release.version']}.
The release is available for download from
https://fineract.apache.org/#downloads

Fineract provides a reliable, robust, and affordable solution for entrepreneurs,
financial institutions, and service providers to offer financial services to the
worldโ€™s 2 billion underbanked and unbanked. Fineract is aimed at innovative mobile
and cloud-based solutions, and enables digital transaction accounts for all.

This release addressed ${project['fineract.release.issues']?size} issues.

Readme: https://github.com/apache/fineract/blob/${project['fineract.release.version']}/README.md

Release page: https://cwiki.apache.org/confluence/display/FINERACT/${project['fineract.release.version']}+-+Apache+Fineract

List of fixed issues:
https://issues.apache.org/jira/secure/ReleaseNote.jspa?version=${project['fineract.release.versionId']}&styleName=Html&projectId=${project['fineract.release.projectId']}

For more information on Apache Fineract please visit
project home page: https://fineract.apache.org

The Apache Fineract Team
Gradle Task
Command
% ./gradlew fineractReleaseStep15 -Pfineract.release.version=1.6.1-107c2290

Frequently Asked Questions

TBD

Glossary

TBD

Index

TBD

Appendix A: Fineract Application Properties

TBD

A.1. Tenant Database Properties

Table 718. Tenant Database Properties
Name Env Variable Default Value Description

fineract.tenant.host

FINERACT_DEFAULT_TENANTDB_HOSTNAME

localhost

TBD

fineract.tenant.port

FINERACT_DEFAULT_TENANTDB_PORT

3306

TBD

fineract.tenant.username

FINERACT_DEFAULT_TENANTDB_UID

root

TBD

fineract.tenant.password

FINERACT_DEFAULT_TENANTDB_PWD

mysql

TBD

fineract.tenant.parameters

FINERACT_DEFAULT_TENANTDB_CONN_PARAMS

TBD

fineract.tenant.timezone

FINERACT_DEFAULT_TENANTDB_TIMEZONE

Asia/Kolkata

TBD

fineract.tenant.identifier

FINERACT_DEFAULT_TENANTDB_IDENTIFIER

default

TBD

fineract.tenant.name

FINERACT_DEFAULT_TENANTDB_NAME

fineract_default

TBD

fineract.tenant.description

FINERACT_DEFAULT_TENANTDB_DESCRIPTION

Default Demo Tenant

TBD

A.2. Hikari Connection Pool Properties

Table 719. Hikari Connection Pool Properties
Name Env Variable Default Value Description

spring.datasource.hikari.driverClassName

FINERACT_HIKARI_DRIVER_SOURCE_CLASS_NAME

org.mariadb.jdbc.Driver

TBD

spring.datasource.hikari.jdbcUrl

FINERACT_HIKARI_JDBC_URL

jdbc:mariadb://localhost:3306/fineract_tenants

TBD

spring.datasource.hikari.username

FINERACT_HIKARI_USERNAME

root

TBD

spring.datasource.hikari.password

FINERACT_HIKARI_PASSWORD

mysql

TBD

spring.datasource.hikari.minimumIdle

FINERACT_HIKARI_MINIMUM_IDLE

3

TBD

spring.datasource.hikari.maximumPoolSize

FINERACT_HIKARI_MAXIMUM_POOL_SIZE

10

TBD

spring.datasource.hikari.idleTimeout

FINERACT_HIKARI_IDLE_TIMEOUT

60000

TBD

spring.datasource.hikari.connectionTimeout

FINERACT_HIKARI_CONNECTION_TIMEOUT

20000

TBD

spring.datasource.hikari.connectionTestquery

FINERACT_HIKARI_TEST_QUERY

SELECT 1

TBD

spring.datasource.hikari.autoCommit

FINERACT_HIKARI_AUTO_COMMIT

true

TBD

spring.datasource.hikari.dataSourceProperties['cachePrepStmts']

FINERACT_HIKARI_DS_PROPERTIES_CACHE_PREP_STMTS

true

TBD

spring.datasource.hikari.dataSourceProperties['prepStmtCacheSize']

FINERACT_HIKARI_DS_PROPERTIES_PREP_STMT_CACHE_SIZE

250

TBD

spring.datasource.hikari.dataSourceProperties['prepStmtCacheSqlLimit']

FINERACT_HIKARI_DS_PROPERTIES_PREP_STMT_CACHE_SQL_LIMIT

2048

TBD

spring.datasource.hikari.dataSourceProperties['useServerPrepStmts']

FINERACT_HIKARI_DS_PROPERTIES_USE_SERVER_PREP_STMTS

true

TBD

spring.datasource.hikari.dataSourceProperties['useLocalSessionState']

FINERACT_HIKARI_DS_PROPERTIES_USE_LOCAL_SESSION_STATE

true

TBD

spring.datasource.hikari.dataSourceProperties['rewriteBatchedStatements']

FINERACT_HIKARI_DS_PROPERTIES_REWRITE_BATCHED_STATEMENTS

true

TBD

spring.datasource.hikari.dataSourceProperties['cacheResultSetMetadata']

FINERACT_HIKARI_DS_PROPERTIES_CACHE_RESULT_SET_METADATA

true

TBD

spring.datasource.hikari.dataSourceProperties['cacheServerConfiguration']

FINERACT_HIKARI_DS_PROPERTIES_CACHE_SERVER_CONFIGURATION

true

TBD

spring.datasource.hikari.dataSourceProperties['elideSetAutoCommits']

FINERACT_HIKARI_DS_PROPERTIES_ELIDE_SET_AUTO_COMMITS

true

TBD

spring.datasource.hikari.dataSourceProperties['maintainTimeStats']

FINERACT_HIKARI_DS_PROPERTIES_MAINTAIN_TIME_STATS

false

TBD

spring.datasource.hikari.dataSourceProperties['logSlowQueries']

FINERACT_HIKARI_DS_PROPERTIES_LOG_SLOW_QUERIES

true

TBD

spring.datasource.hikari.dataSourceProperties['dumpQueriesOnException']

FINERACT_HIKARI_DS_PROPERTIES_DUMP_QUERIES_IN_EXCEPTION

true

TBD

A.3. SSL Properties

Table 720. SSL Properties
Name Env Variable Default Value Description

server.ssl.enabled

FINERACT_SERVER_SSL_ENABLED

true

TBD

server.ssl.protocol

FINERACT_SERVER_SSL_PROTOCOL

TLS

TBD

server.ssl.ciphers

FINERACT_SERVER_SSL_CIPHERS

TLS_RSA_WITH_AES_128_CBC_SHA256

TBD

server.ssl.enabled-protocols

FINERACT_SERVER_SSL_PROTOCOLS

TLSv1.2

TBD

server.ssl.key-store

FINERACT_SERVER_SSL_KEY_STORE

classpath:keystore.jks

TBD

server.ssl.key-store-password

FINERACT_SERVER_SSL_KEY_STORE_PASSWORD

openmf

TBD

A.4. Authentication Properties

Table 721. Authentication Properties
Name Env Variable Default Value Description

fineract.security.basicauth.enabled

FINERACT_SECURITY_BASICAUTH_ENABLED

true

TBD

fineract.security.oauth.enabled

FINERACT_SECURITY_OAUTH_ENABLED

false

TBD

fineract.security.2fa.enabled

FINERACT_SECURITY_2FA_ENABLED

false

TBD

A.5. Tomcat Properties

Table 722. Tomcat Properties
Name Env Variable Default Value Description

server.tomcat.accept-count

FINERACT_SERVER_TOMCAT_ACCEPT_COUNT

100

TBD

server.tomcat.accesslog.enabled

FINERACT_SERVER_TOMCAT_ACCESSLOG_ENABLED

false

TBD

server.tomcat.max-connections

FINERACT_SERVER_TOMCAT_MAX_CONNECTIONS

8192

TBD

server.tomcat.max-http-form-post-size

FINERACT_SERVER_TOMCAT_MAX_HTTP_FORM_POST_SIZE

2MB

TBD

server.tomcat.max-keep-alive-requests

FINERACT_SERVER_TOMCAT_MAX_KEEP_ALIVE_REQUESTS

100

TBD

server.tomcat.threads.max

FINERACT_SERVER_TOMCAT_THREADS_MAX

200

TBD

server.tomcat.threads.min-spare

FINERACT_SERVER_TOMCAT_THREADS_MIN_SPARE

10

TBD

Appendix B: Third Party Software

TBD